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"
      },
      "custom_fields":{
         "CONTACT_INFO":[
            {
               "id":"cf_89c341606fea47f1be19a09106d877c4",
               "required":true,
               "label":"Do you want to add a gift message with your order?",
               "type":"RADIO_LIST",
               "placeholder":null,
               "options":[
                  "Yes",
                  "No"
               ]
            }
         ],
         "SHIPPING_ADDRESS":[
            {
               "id":"cf_89c341606fea47f1be19a09106d877c4",
               "required":true,
               "label":"Do you want to add a gift message with your order?",
               "type":"DATE",
               "placeholder":null,
               "options":[
                  "Yes",
                  "No"
               ],
               "includes_time":true,
               "date_range_policy":"ANY"
            }
         ],
         "SHIPPING_METHODS":[
            {
               "id":"cf_89c341606fea47f1be19a09106d877c4",
               "required":true,
               "label":"Do you want to add a gift message with your order?",
               "type":"RADIO_LIST",
               "placeholder":null,
               "options":[
                  "Yes",
                  "No"
               ]
            }
         ],
         "BILLING_ADDRESS":[
            {
               "id":"cf_89c341606fea47f1be19a09106d877c4",
               "required":true,
               "label":"Do you want to add a gift message with your order?",
               "type":"DATE",
               "placeholder":null,
               "options":[
                  "Yes",
                  "No"
               ],
               "includes_time":true,
               "date_range_policy":"ANY"
            }
         ],
         "PAYMENT_METHODS":[
            {
               "id":"cf_89c341606fea47f1be19a09106d877c4",
               "required":true,
               "label":"Do you want to add a gift message with your order?",
               "type":"RADIO_LIST",
               "placeholder":null,
               "options":[
                  "Yes",
                  "No"
               ]
            }
         ]
      }
   },
   "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.
custom_fields object	Record of custom field location <> array of custom fields. Possible zone values in the record: CONTACT_INFO, SHIPPING_ADDRESS, SHIPPING_METHODS, BILLING_ADDRESS, PAYMENT_METHODS Note that we enforce a maximum of 5 custom field per zone the update call will 400 if any zone exceed this limit. Note that the order of the fields in each zone’s array will dictate its display order in the checkout.

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

custom_fields

Property	Description
CONTACT_INFO array_of_objects	The custom fields value types
SHIPPING_ADDRESS array_of_objects
SHIPPING_METHODS array_of_objects
BILLING_ADDRESS array_of_objects
PAYMENT_METHODS array_of_objects

custom_fields value types

Property	Description
id string	Unique identifier of the custom zone, auto-generated by us, and useful to track the setting to it’s equivalent in orders and carts. Optional will be auto-generated when not provided. Will 404 if provided and not found in the list of existing custom fields
required bool	Bool to set the custom field as required in the checkout. If this is set to true, customers will face validation errors if they leave the custom field empty. Defaults to false
label string	Label displayed alongside the input in the checkout inputs, emails, and in the merchant dashboard. Required, max value of 500 chars.
type string	Input type of the custom fields. Possible input types are: TEXT, TEXTAREA, SELECT, RADIO_LIST, CHECKBOX, DATE Required
placeholder string	Visible placeholder value in the input field, to help customers with an example value expected my the merchants. Note that this parameter is not supported for custom fields of type RADIO_LIST and CHECKBOX. The update call will 400 if a value is passed for those types. Optional, max value of 200 chars
options array of strings	Array of pre-defined string options for fields of type RADIO_LIST and SELECT. All options in the array must be unique, required when type RADIO_LIST or SELECT. Always empty for the other type,m sax of 500 options if the type is SELECT and max of 5 options if the type is RADIO_LIST.
includes_time boolean	When true, the date custom field stores a timestamp; when false, date-only. Required in settings request when type is DATE. Only allowed when type is DATE.
date_range_policy string	Range policy for date custom fields. Required in settings request when type is DATE. Only allowed when type DATE. Enum values: ANY, PAST_ONLY, FUTURE_ONLY

tax_settings

Property Description

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

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