eCommerce Settings: Sample Flows

This article presents possible use cases and corresponding sample flows that you can support. It provides a useful starting point as you plan your implementation.

Format prices in the site's currency

An app that shows prices outside the site's own pages, such as in a widget or an email, needs the currency and locale the business uses. Business locale holds both.

To format prices in the site's currency:

  1. Call Get eCommerce Settings with fields set to ["BUSINESS_LOCALE"].
  2. Check errors. If it contains BUSINESS_LOCALE, use a default currency and call the method again later.
  3. Read ecommerceSettings.businessLocale.currency for the currency code and ecommerceSettings.businessLocale.locale to format numbers and dates.

List the countries a site delivers to

An app that collects a shipping address can limit the address form to destinations the site delivers to. Delivery settings list each country, and sometimes only some of its subdivisions, such as states or provinces.

To list the countries a site delivers to:

  1. Call Get eCommerce Settings with fields set to ["DELIVERY"].
  2. Check ecommerceSettings.delivery.restOfWorld. If it's set, the site delivers to every country, so allow any country.
  3. If restOfWorld isn't set, allow only the countries in ecommerceSettings.delivery.countries. For each country:
    • If the country has deliveryDestinationProperties, allow the whole country.
    • If it doesn't, allow only the subdivisions listed in its subdivisions.
  4. For a country that lists subdivisions but has no deliveryDestinationProperties, require a subdivision in the address form. Without one, the address can't get delivery rates, even when restOfWorld is set.
  5. For each allowed destination, read postalCodeRequired to decide whether to require a postal code, and pickupOnly to tell whether only pickup is available. Read them from the most specific match: the listed subdivision's deliveryDestinationProperties, then the country's, then restOfWorld.

Check whether a store is ready to sell

A setup checklist in a merchant's dashboard can show which steps are still missing before the store can sell.

To check whether a store is ready to sell:

  1. Call Get eCommerce Settings with fields set to ["PREMIUM_SITE", "TAX"].
  2. Flag each step that's missing:
    • premiumSite is false: The site doesn't have a premium plan that supports accepting payments.
    • tax.configured is false: The site has no tax regions.
  3. For any field listed in errors, show the step as unknown instead of missing.

Last updated: 18 November 2026

Did this help?