Skip to main content

About the Markets API

We're expanding Markets capabilities beyond region-based markets. Location-based (retail) and company location based (B2B) markets are now available, along with more customization options.

Anchor to How it worksHow it works

The following diagram describes the relationships between API objects related to markets:

Market entities
Api objectDescription
MarketA group of one or more regions, company locations or retail locations to target sales. By creating a market, you can configure distinct, localized shopping experiences for customers. For example, you can configure currency, domains and languages, prices, published products, and theme customizations.
ConditionAn attribute that qualifies a buyer for a market. For example, the region a buyer is located in, the company location they are purchasing on behalf of, or the retail location.

Anchor to Market conditionsMarket conditions

Market conditions define what types of buyers are going to match certain markets.

  • A market with a Region condition of Canada will match all buyers from that region.

  • A market with a CompanyLocation condition of a certain company will match all logged buyers from that company location.

  • A market with a Location condition will match all POS buyers for that location.

    A market can also hold several conditions of the same type. For example, a market can hold several regions, like the US, Canada, or several company locations.

    Markets also support wildcards, which contain all retail locations or all company locations for a geography. For example, you might want to include all company locations in all regions, or all POS locations in Canada.

Anchor to Market customizationsMarket customizations

A market can hold any combination of customizations.

  • CurrencySettings: Associate a particular currency with a given market.
  • Catalogs: Associate one or more catalogs with the market.
  • WebPresences: Associate one or more web presences with the market.
  • PriceInclusions: Associate different pricing behaviour for taxes and duties with a particular market

Anchor to Next stepsNext steps

Was this page helpful?