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"
  },
  "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",
    "marketing_opt_in_settings": {
      "is_enabled": true,
      "description_markup": "string"
    }
  },
  "contact_email": "string",
  "contact_name": "string",
	"tax_settings": {
		"calculation_mode": "TAXES_INCLUDED_IN_PRICE",
		"default_tax_zone_id": "string"
	},
  "show_lowest_price": true,
  "measurement_system": "IMPERIAL"
}

settings

Property

Description

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 of 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.

measurement_system string

The measurement system to be used. Can be IMPERIAL or METRIC.

business_address

Property

Description

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

Property

Description

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.

marketing_opt_in_settings object

Optional filed for customers to opt-in for promotional content.

marketing_opt_in_settings

Property

Description

is_enabled bool

Should the customer be opted in for promotional content.

description_markup string

HTML string to replace the default label. Only tags supported are: p, a, em, i, strong, u, br

tax_settings

Property

Description

calculation_mode string

Value to set how we will calculate taxes on a cart/order.

  • TAXES_INCLUDED_IN_PRICE* The customers will see the product prices with taxes included, based on the default tax zone id. A tax zone must exist on the store to set the calculation_mode to this value.
  • TAXES_EXCLUDED_FROM_PRICE* (Default) The customers will see the product prices without taxes included.

If Avalara is used and active for a site, this will always be set to TAXES_EXCLUDED_FROM_PRICE.

default_tax_zone_id
string

Tax zone to apply the “estimated taxes” and the taxes included in prices. This value can be null when no taxes zone is set in the store, but will always be set otherwise. If the selected tax zone is deleted in the UI or the API, our system will select automatically another one. If the PATCH endpoint includes a non-existing tax zone id, the server will respond a 400 status code with a meaningful error message in the payload.