Links

Retrieve a custom promotion rule

How to fetch a specific custom promotion rule via API
To fetch a single custom promotion rule, send a GET request to the /api/custom_promotion_rules/:id endpoint, where id is the ID of the resource that you want to retrieve.

Request

GET https://yourdomain.commercelayer.io/api/custom_promotion_rules/:id

Example

Request
Response
The following request fetches the custom promotion rule identified by the id "xYZkjABcde":
curl -g -X GET \
'https://yourdomain.commercelayer.io/api/custom_promotion_rules/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": "custom_promotion_rules",
"links": {
"self": "https://yourdomain.commercelayer.io/api/custom_promotion_rules/xYZkjABcde"
},
"attributes": {
"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"
},
"filters": {
"status_eq": "pending",
"line_items_sku_code_eq": "AAA"
}
},
"relationships": {
"promotion": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/custom_promotion_rules/xYZkjABcde/relationships/promotion",
"related": "https://yourdomain.commercelayer.io/api/custom_promotion_rules/xYZkjABcde/promotion"
}
},
"versions": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/custom_promotion_rules/xYZkjABcde/relationships/versions",
"related": "https://yourdomain.commercelayer.io/api/custom_promotion_rules/xYZkjABcde/versions"
}
}
},
"meta": {
"mode": "test"
}
}
}