Retrieve a market
How to fetch a specific market via API
To fetch a single market, send a GET
request to the /api/markets/:id
endpoint, where id
is the ID of the resource that you want to retrieve.
Request
GET https://yourdomain.commercelayer.io/api/markets/:id
Example
The following request fetches the market identified by the id "xYZkjABcde":
curl -g -X GET \
'https://yourdomain.commercelayer.io/api/markets/xYZkjABcde' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token'
On success, the API responds with a 200 OK
status code, returning a single resource object:
{
"data": {
"id": "xYZkjABcde",
"type": "markets",
"links": {
"self": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde"
},
"attributes": {
"checkout_url": "https://checkout.yourbrand.com/:order_id",
"code": "europe1",
"created_at": "2018-01-01T12:00:00.000Z",
"disabled_at": "2018-01-01T12:00:00.000Z",
"external_order_validation_url": "https://external_validation.yourbrand.com",
"external_prices_url": "https://external_prices.yourbrand.com",
"facebook_pixel_id": "1234567890",
"metadata": {
"foo": "bar"
},
"name": "EU Market",
"number": 1234,
"private": true,
"reference": "ANY-EXTERNAL-REFEFERNCE",
"reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
"shared_secret": "1c0994cc4e996e8c6ee56a2198f66f3c",
"shipping_cost_cutoff": 3,
"updated_at": "2018-01-01T12:00:00.000Z"
},
"relationships": {
"attachments": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/relationships/attachments",
"related": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/attachments"
}
},
"base_price_list": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/relationships/base_price_list",
"related": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/base_price_list"
}
},
"customer_group": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/relationships/customer_group",
"related": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/customer_group"
}
},
"geocoder": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/relationships/geocoder",
"related": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/geocoder"
}
},
"inventory_model": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/relationships/inventory_model",
"related": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/inventory_model"
}
},
"merchant": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/relationships/merchant",
"related": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/merchant"
}
},
"price_list": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/relationships/price_list",
"related": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/price_list"
}
},
"price_list_schedulers": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/relationships/price_list_schedulers",
"related": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/price_list_schedulers"
}
},
"subscription_model": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/relationships/subscription_model",
"related": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/subscription_model"
}
},
"tax_calculator": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/relationships/tax_calculator",
"related": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/tax_calculator"
}
},
"versions": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/relationships/versions",
"related": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/versions"
}
}
},
"meta": {
"mode": "test"
}
}
}
Last updated