--- title: "Update account settings" method: PATCH path: "/api/sites/multiscreen/{site_name}/ecommerce" tags: ["Account"] --- # Update account settings `PATCH /api/sites/multiscreen/{site_name}/ecommerce` ## Request - Base URL: `https://api.duda.co` - URL: `https://api.duda.co/api/sites/multiscreen/{site_name}/ecommerce` - Auth: HTTP basic Updates the ecommerce account settings for the site. Accepts changes to default currency, business name and address, time zone, enabled countries, email notification preference, contact information, cart settings, tax settings, lowest-price display, measurement system, and digital goods URL expiration. ## Path parameters - `site_name` string, required ## Request body - UpdateAccountSettingsInputDto - `default_currency` string, nullable: ISO 4217 3-letters currency code. Ref: https://en.wikipedia.org/wiki/ISO_4217 - `business_name` string, nullable: The full name of the business - `business_address` BusinessAddressInputDto - `address_1` string, required: Number and Street, concatenated - `address_2` string, nullable: Address complement (apt #, office #, floor level, etc.) - `city` string, required: City name - `sub_locality` string, nullable: Neighbourhood - `region` string, nullable: The administrative region (depending on country, this can be a state, province, department, etc.) - `country` string, required: ISO 3166 2-letters ISO country code. Ref: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes - `postal_code` string, nullable: Postal code - `phone` string, nullable: Phone number - `time_zone` string, nullable: Time zone settings - `timezone` string, nullable: IANA time zone identifier of the store (e.g. America/New_York). Dates that must land in the store's local time, such as a discount's validity window, are resolved in it. Omit to leave unchanged; send null to reset it to UTC. - `enabled_countries` string[], nullable: Enabled countries ISO 3166 2-letters country code. Ref: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes - `send_email_notifications` boolean, nullable: Activate/deactivate automatic email delivery to customers when they complete an order or receive a refund - `contact_name` string, nullable: Name displayed to customers so they can contact for support - `contact_email` string, nullable: Email address displayed to customers so they can contact for support - `cart_settings` CartSettingsRequestDto - `split_name_field` boolean, nullable: Option to separate the fullname in addresses into a first name and last name fields - `split_address_1_field` boolean, nullable: Option to separate the address 1 in addresses into a street number and street name fields - `display_instruction_field` boolean, nullable: Option to add an instruction field to the checkout process so customers can leave delivery notes - `display_phone_field` boolean, nullable: Option to add a phone number to addresses in the checkout process - `display_login` boolean, nullable: Option to display the login option in the checkout process - `display_product_recommendations` boolean, nullable: Option to display product recommendations in the cart - `email_marketing_opt_in_settings` CartSettingsMarketingOptInFieldRequestDto - `enabled` boolean: Enable marketing opt-in checkbox in cart checkout settings - `description_html` string, nullable: HTML description to display alongside the marketing opt-in checkbox - `sms_marketing_opt_in_settings` CartSettingsMarketingOptInFieldRequestDto - `enabled` boolean: Enable marketing opt-in checkbox in cart checkout settings - `description_html` string, nullable: HTML description to display alongside the marketing opt-in checkbox - `marketing_opt_in_settings` CartSettingsMarketingOptInFieldRequestDto - `enabled` boolean: Enable marketing opt-in checkbox in cart checkout settings - `description_html` string, nullable: HTML description to display alongside the marketing opt-in checkbox - `terms_and_conditions_html` string, nullable: Terms and conditions HTML to display alongside a required checkbox in the checkout process. If the value is null, the checkbox feature will be disabled and hidden. - `order_confirmation_page_url` string, nullable - `custom_fields` object, nullable: Custom fields added in the checkout experience of a customer - `tax_settings` UpdateTaxesSettingsRequestDto - `calculation_mode` 'TAXES_EXCLUDED_FROM_PRICE' | 'TAXES_INCLUDED_IN_PRICE' - `default_tax_zone_id` string, nullable: The default tax zone the system will use to compute taxes included in product prices, or the estimated taxes feature - `show_lowest_price` boolean, nullable - `measurement_system` 'METRIC' | 'IMPERIAL' - `digital_goods_url_expiration_in_days` integer, nullable: Length in days before digital goods download URL expires. Omit to leave unchanged; send null for unlimited. ## Response `200` OK - AccountSettingsOutputDto - `default_currency` string, nullable: ISO 4217 3-letters currency code. Ref: https://en.wikipedia.org/wiki/ISO_4217 - `business_name` string, nullable: The full name of the business - `business_address` BusinessAddressOutputDto - `address_1` string, nullable: Number and Street, concatenated - `address_2` string, nullable: Address complement (apt #, office #, floor level, etc.) - `city` string, nullable: City name - `sub_locality` string, nullable - `region` string, nullable: The administrative region (depending on country, this can be a state, province, department, etc.) - `country` string, nullable: ISO 3166 2-letters ISO country code. Ref: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes - `postal_code` string, nullable: Postal code - `phone` string, nullable: Phone number of the business - `time_zone` string, nullable: Time zone settings - `timezone` string, nullable: IANA time zone identifier of the store. Dates that must land in the store's local time, such as a discount's validity window, are resolved in it. - `enabled_countries` string[], nullable: Enabled countries ISO 3166 2-letters country code. Ref: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes - `send_email_notifications` boolean, nullable: Activate/deactivate automatic email delivery to customers when they complete an order or receive a refund - `cart_settings` CartSettingsOutputDto - `split_name_field` boolean, nullable: Option to separate the fullname in addresses into a first name and last name fields - `split_address_1_field` boolean, nullable: Option to separate the address 1 in addresses into a street number and street name fields - `display_instruction_field` boolean, nullable: Option to add an instruction field to the checkout process so customers can leave delivery notes - `display_phone_field` boolean, nullable: Option to add a phone number to addresses in the checkout process - `display_login` boolean, nullable: Option to display the login option in the checkout process - `display_product_recommendations` boolean: Option to display product recommendations in the cart - `email_marketing_opt_in_settings` CartSettingsMarketingOptInFieldResponseDto - `enabled` boolean: Enable marketing opt-in checkbox in cart checkout settings - `description_html` string, nullable: HTML description to display alongside the marketing opt-in checkbox - `sms_marketing_opt_in_settings` CartSettingsMarketingOptInFieldResponseDto - `enabled` boolean: Enable marketing opt-in checkbox in cart checkout settings - `description_html` string, nullable: HTML description to display alongside the marketing opt-in checkbox - `marketing_opt_in_settings` CartSettingsMarketingOptInFieldResponseDto - `enabled` boolean: Enable marketing opt-in checkbox in cart checkout settings - `description_html` string, nullable: HTML description to display alongside the marketing opt-in checkbox - `terms_and_conditions_html` string, nullable: Terms and conditions HTML to display alongside a required checkbox in the checkout process. If the value is null, the checkbox feature will be disabled and hidden. - `order_confirmation_page_url` string, nullable - `custom_fields` object: Custom fields to add in the checkout experience of a customer - `tax_settings` TaxSettingsResponseDto - `calculation_mode` 'TAXES_EXCLUDED_FROM_PRICE' | 'TAXES_INCLUDED_IN_PRICE' - `default_tax_zone_id` string, nullable: The default tax zone the system will use to compute taxes included in product prices, or the estimated taxes feature - `contact_email` string, nullable: The email address customers can contact for order support - `contact_name` string, nullable: The name customers can contact for order supports - `show_lowest_price` boolean: If true, the customer needs to be shown the lowest price that any customer might see. This origin of this setting is to comply to the Enforcement and Modernisation Directive in the EU, also known as the Omnibus Directive - `measurement_system` 'METRIC' | 'IMPERIAL' ## Other responses - `400`: Bad Request - `401`: Unauthorized - `403`: Forbidden - `404`: Not Found - `422`: Unprocessable Content - `429`: Too many requests. The rate limit was exceeded. --- [API](https://skmtc.dev/duda/apis/duda-partner-api.md) - [All operations](https://skmtc.dev/duda/apis/duda-partner-api/llms.txt) - [OpenAPI document](https://skmtc.dev/duda/apis/duda-partner-api/revisions/52be4d41cb12?raw)