Storefronts (Websites)

Storefronts (Websites)

A storefront (website) is one online store with its own domain, default
currency, locale and country. Many endpoints accept a websiteId to scope
results or price products in that storefront's currency — this endpoint is how
you discover those ids.

Requires data:read.

List storefronts

GET /papi/v1/websites

{
  "data": [
    {
      "id": "…",
      "slug": "us-store",
      "name": "US Store",
      "defaultCurrency": "USD",
      "defaultLocale": "en",
      "defaultCountryCode": "US"
    }
  ],
  "total": 1
}

Using websiteId

Take the id of the storefront you want and pass it wherever a websiteId
parameter is accepted:

• Products — GET /products?websiteId=<id> and
  GET /products/{id}?websiteId=<id> return prices in that storefront's
  currency.
• Orders — websiteId is required when creating an order so it is attached
  to the correct storefront.
• Sales channels — Google Merchant and Meta Commerce syncs are scoped per
  storefront (/websites/{id}/…).

If you pass a websiteId that doesn't belong to your entity, the API returns
403 website_not_in_entity.