Markets
A market is made of a merchant, an inventory model, and a price list (plus an optional customer group, geocoder, and tax calculator). Sales channel applications must specify a market scope when obtaining an access token. This way, all the resources (e.g., SKUs, prices, stock items) are automatically filtered.
A market object is returned as part of the response body of each successful create, list, retrieve, or update API call.
Field | Type | Description |
type |
|
|
id |
| The market unique identifier |
links.self |
| The market endpoint URL |
attributes.number |
| Unique identifier for the market (numeric) |
attributes.name |
| The market's internal name |
attributes.facebook_pixel_id |
| The Facebook Pixed ID |
attributes.checkout_url |
| The checkout URL for this market |
attributes.external_prices_url |
| The URL used to fetch prices from an external source |
attributes.private |
| Indicates if market belongs to a customer_group. |
attributes.created_at |
| Time at which the resource was created. |
attributes.updated_at |
| Time at which the resource was last updated. |
attributes.reference |
| A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. |
attributes.reference_origin |
| Any identifier of the third party system that defines the reference code |
attributes.metadata |
| Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. |
relationships.merchant |
| The associated merchant. |
relationships.price_list |
| The associated price list. |
relationships.inventory_model |
| The associated inventory model. |
relationships.customer_group |
| The associated customer group. |
meta.mode |
| The resource environment (can be one of |
