v1

latestOpenAPI 3.1.02026-07-242470655.6 KB

Get Settings

get/sites/multiscreen/{site_name}/ecommerce

Path parameters

site_namestring required

The unique identifier for the target Site.

Response

200

business_namestring
contact_emailstring
contact_namestring
default_currencystring
enabled_countriesstring[]
measurement_systemstring
send_email_notificationsboolean
show_lowest_priceboolean
time_zonestring

Example response

{
  "business_address": {
    "address_1": "string",
    "address_2": "string",
    "city": "string",
    "country": "string",
    "phone": "string",
    "postal_code": "string",
    "region": "string",
    "sub_locality": "string"
  },
  "business_name": "string",
  "cart_settings": {
    "display_instruction_field": true,
    "display_phone_field": true,
    "marketing_opt_in_settings": {
      "description_markup": "string",
      "is_enabled": true
    },
    "split_address_1_field": true,
    "split_name_field": true,
    "terms_and_conditions_html": "string"
  },
  "contact_email": "string",
  "contact_name": "string",
  "default_currency": "string",
  "enabled_countries": [
    "string"
  ],
  "measurement_system": "IMPERIAL",
  "send_email_notifications": true,
  "show_lowest_price": true,
  "tax_settings": {
    "calculation_mode": "TAXES_INCLUDED_IN_PRICE",
    "default_tax_zone_id": "string"
  },
  "time_zone": "string"
}