How to fetch a specific merchant via API
Last updated 5 months ago
To a single merchant, send a GET request to the /api/merchants/:id endpoint, where id is the ID of the resource that you want to retrieve.
GET
/api/merchants/:id
id
GET https://yourdomain.commercelayer.io/api/merchants/:id
The following request fetches the merchant identified by the id "xYZkjABcde":
curl -g -X GET \ 'https://yourdomain.commercelayer.io/api/merchants/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:
200 OK
{ "data": { "id": "xYZkjABcde", "type": "merchants", "links": { "self": "https://yourdomain.commercelayer.io/api/merchants/xYZkjABcde" }, "attributes": { "name": "The Brand Inc.", "created_at": "2018-01-01T12:00:00.000Z", "updated_at": "2018-01-01T12:00:00.000Z", "reference": "ANY-EXTERNAL-REFEFERNCE", "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "metadata": { "foo": "bar" } }, "relationships": { "address": { "links": { "self": "https://yourdomain.commercelayer.io/api/merchants/xYZkjABcde/relationships/address", "related": "https://yourdomain.commercelayer.io/api/merchants/xYZkjABcde/address" } }, "attachments": { "links": { "self": "https://yourdomain.commercelayer.io/api/merchants/xYZkjABcde/relationships/attachments", "related": "https://yourdomain.commercelayer.io/api/merchants/xYZkjABcde/attachments" } }, "versions": { "links": { "self": "https://yourdomain.commercelayer.io/api/merchants/xYZkjABcde/relationships/versions", "related": "https://yourdomain.commercelayer.io/api/merchants/xYZkjABcde/versions" } } }, "meta": { "mode": "test", "organization_id": "xRRkjDFafe", "trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74" } } }