Settings Object

{
  "default_currency": "string",
  "business_name": "string",
  "business_address": {
    "address_1": "string",
    "address_2": "string",
    "city": "string",
    "sub_locality": "string",
    "region": "string",
    "country": "string",
    "postal_code": "string",
    "phone": "string"
  },
  "time_zone": "string",
  "enabled_countries": [
    "string"
  ],
  "send_email_notifications": true,
  "cart_settings": {
    "split_name_field": true,
    "split_address_1_field": true,
    "display_instruction_field": true,
    "display_phone_field": true,
    "terms_and_conditions_html": "string"
  },
  "contact_email": "string",
  "contact_name": "string",
  "show_lowest_price": true
}

settings

PropertyDescription
default_currency
string
ISO 4217 3-letters currency code. Ref: https://en.wikipedia.org/wiki/ISO_4217.
business_name
string
The full name of the business.
business_address
object
The address if the business.
time_zone
string
Time zone settings.
enabled_countries
string
Enabled countries ISO 3166 2-letters country code. Ref: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes.
send_email_notifications
boolean
Activate/deactivate automatic email delivery to customers when they complete an order or receive a refund.
cart_settings
object
The settings applied to user carts.
contact_email
string
The email address customers can contact for order support.
contact_name
string
The name customers can contact for order supports.
show_lowest_price
boolean
If true, shows the lowest price that any customer might see.

business_address

PropertyDescription
address_1
string
Number and Street, concatenated.
address_2
string
Address complement (apt #, office #, floor level, etc.).
city
string
City name.
sub_locality
string
Sub-locality attached to the address (ex: county or district name).
region
string
The administrative region (depending on country, this can be a state, province, department, etc.).
country
string
ISO 3166 2-letters ISO country code. Ref: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes.
postal_code
string
Postal code.
phone
string
Phone Number.

cart_settings

PropertyDescription
split_name_field
bool
Should the full name of the cart owner be split into first and last name fields.
split_address_1_field
bool
Should addresses associated with the cart be split into street number and street name fields.
display_instruction_field
bool
Should the cart display an instruction field.
display_phone_field
bool
Should the cart display a phone field.