About the eCommerce Settings API

The eCommerce Settings API returns a read-only snapshot of how a site's eCommerce is set up. Use it when you need several of these values in one call.

With the eCommerce Settings API, you can retrieve a site's:

  • Business locale and business information.
  • Checkout settings.
  • Delivery destinations.
  • Tax and discount configuration.
  • Premium status: whether the site has a premium plan that supports accepting payments.
  • Active service plugin providers.

Each value comes from the API that owns it, for example the Checkout Settings API or the Tax Regions API. To change a setting, call the API that owns it.

Before you begin

It's important to note the following points before starting to code:

  • Specify at least one value in fields. The response includes only the fields you request.
  • Each requested field is fetched separately. If one can't be retrieved, it's left out of ecommerceSettings, and an entry in errors names it. The other fields are still returned, so check errors before treating a missing field as empty.
  • Responses can be cached. A change made through an owning API can take a short time to appear here.

Use cases

Terminology

  • Requested field: A value of fields that selects one part of the settings to return, such as BUSINESS_LOCALE or DELIVERY.
  • Rest of world: The delivery destination that covers every country that isn't listed in delivery.countries, and every unlisted subdivision of a listed country that has no country-level deliveryDestinationProperties.
  • Service plugin: An extension point where an app adds logic to the eCommerce flow, such as additional fees or validations. An active provider is an app that implements the plugin on the site.

Last updated: 18 November 2026

Did this help?