Retrieve a link
How to fetch a specific link via API
To fetch a single link, send a GET request to the /api/links/:id endpoint, where id is the ID of the resource that you want to retrieve.
Request
GET https://yourdomain.commercelayer.io/api/links/:id
Example
The following request fetches the link identified by the ID "XAyRWNUzyN":
curl -g -X GET \
'https://yourdomain.commercelayer.io/api/links/XAyRWNUzyN' \
-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": "XAyRWNUzyN",
"type": "links",
"links": {
"self": "https://yourdomain.commercelayer.io/api/links/XAyRWNUzyN"
},
"attributes": {
"name": "FW SALE 2023",
"client_id": "xxxx-yyyy-zzzz",
"scope": "market:id:GhvCxsElAQ,market:id:kJhgVcxZDr",
"starts_at": "2018-01-01T12:00:00.000Z",
"expires_at": "2018-01-02T12:00:00.000Z",
"active": true,
"status": "pending",
"domain": "commercelayer.link",
"url": "https://commercelayer.link/ZXUtd2VzdC0xLzE5ZjBlMGVlLTg4OGMtNDQ1Yi1iYTA0LTg3MTUxY2FjZjFmYQ",
"item_type": "orders",
"params": {
"param1": "ABC",
"param2": "XYZ"
},
"disabled_at": "2018-01-01T12:00:00.000Z",
"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": {
"item": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/links/XAyRWNUzyN/relationships/item",
"related": "https://yourdomain.commercelayer.io/api/links/XAyRWNUzyN/item"
}
},
"events": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/links/XAyRWNUzyN/relationships/events",
"related": "https://yourdomain.commercelayer.io/api/links/XAyRWNUzyN/events"
}
},
"event_stores": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/links/XAyRWNUzyN/relationships/event_stores",
"related": "https://yourdomain.commercelayer.io/api/links/XAyRWNUzyN/event_stores"
}
}
},
"meta": {
"mode": "test",
"organization_id": "xRRkjDFafe",
"trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
}
}
}Last updated