Config Properties

NOTE: This page is still a work in progress. Eventually, it will describe each option available in the config.

store_id

This is your decimal store ID please don't edit this!

Type: String

Example:

"store_id": "5885461fe3e738239c61bf19"

show_option

This property enables or disables if the rates should show "Option 1:", "Option 2:"... infront of each rate.

Type: Boolean

Example:

"show_option": true

origins

This is an array of addresses that are possible origins

Type: Array[Origin]

Example:

"origins": [
    {
        "name": "default",
        "address": {
            "country": "US",
            "postal_code": "",
            "province": "",
            "city": "",
            "address1": ""
        }
    }
]

Origin

An Origin object

Type: Object

Properties:

• name

  • Type: String
  • A name for referencing this origin elsewhere in the config

• address

  • Type: Object(Address)
  • The address for this origin

Example:

{
    "name": "default",
    "address": {
        "street1": "",
        "city": "",
        "postal_code": "",
        "province": "",
        "country": "US"
    }
}

Address

An Address object

Type: Object

Properties:

• name

  • Type: String
  • The name for the sender (usually blank if company is filled)

• company

  • Type: String
  • The sending company

Example:

{
    "name": "default",
    "address": {
        "name": "",
        "company": "",
        "street1": "",
        "city": "",
        "postal_code": "",
        "province": "",
        "country": "US"
    }
}