Comment on page
The market object
A comprehensive list of the market resource's attributes and relationships
A market object is returned as part of the response body of each successful list, retrieve, create or update API call to the
/api/markets endpoint.Field | Type | Description |
|---|---|---|
type | string | markets |
id | string | The market unique identifier |
links.self | string | The market endpoint URL |
attributes.number | integer | Unique identifier for the market (numeric) |
attributes.name | string | The market's internal name |
attributes.facebook_pixel_id | string | The Facebook Pixed ID |
attributes.checkout_url | string | The checkout URL for this market |
attributes.external_prices_url | string | The URL used to overwrite prices by an external source. |
attributes.external_order_validation_url | string | The URL used to validate orders by an external source. |
attributes.shared_secret | string | The shared secret used to sign the external requests payload. |
attributes.private | boolean | Indicates if market belongs to a customer_group. |
attributes._disable | boolean | Send this attribute if you want to mark the market as disabled. |
attributes._enable | boolean | Send this attribute if you want to mark the market as enabled. |
attributes.disabled_at | datetime | Time at which the market was disabled. |
attributes.created_at | datetime | Time at which the resource was created. |
attributes.updated_at | datetime | Time at which the resource was last updated. |
attributes.reference | string | 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 | string | Any identifier of the third party system that defines the reference code |
attributes.metadata | object | 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 | object | The associated merchant. |
relationships.price_list | object | The associated price list. |
relationships.inventory_model | object | The associated inventory model. |
relationships.subscription_model | object | The associated subscription model. |
relationships.tax_calculator | object | The associated tax calculator. |
relationships.customer_group | object | The associated customer group. |
relationships.attachments | array | The associated attachments. |
relationships.versions | array | The associated changes. |
meta.mode | string | The resource environment (can be one of test or live) |
Last modified 3mo ago