List all promotion rules
How to fetch a collection of promotion rules via API
To fetch a collection of promotion rules, send a GET request to the /api/promotion_rules endpoint.
Request
GET https://yourdomain.commercelayer.io/api/promotion_rules
Example
The following request fetches a collection of promotion rules:
curl -g -X GET \
'https://yourdomain.commercelayer.io/api/promotion_rules/' \
-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 paginated collection of resource objects:
{
"data": [
{
"id": "xYZkjABcde",
"type": "promotion_rules",
"links": {
"self": "https://yourdomain.commercelayer.io/api/promotion_rules/xYZkjABcde"
},
"attributes": {
"type": "coupon_codes_promotion_rules",
"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": {
"promotion": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/promotion_rules/xYZkjABcde/relationships/promotion",
"related": "https://yourdomain.commercelayer.io/api/promotion_rules/xYZkjABcde/promotion"
}
},
"versions": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/promotion_rules/xYZkjABcde/relationships/versions",
"related": "https://yourdomain.commercelayer.io/api/promotion_rules/xYZkjABcde/versions"
}
}
},
"meta": {
"mode": "test",
"organization_id": "xRRkjDFafe",
"trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
}
},
{
"other": "... 9 promotion_rules (first page)"
}
],
"meta": {
"record_count": 140,
"page_count": 14
},
"links": {
"first": "https://yourdomain.commercelayer.io/api/promotion_rules?page[number]=1&page[size]=10",
"next": "https://yourdomain.commercelayer.io/api/promotion_rules?page[number]=2&page[size]=10",
"last": "https://yourdomain.commercelayer.io/api/promotion_rules?page[number]=14&page[size]=10"
}
}
Remember that when you fetch a list of resources you get paginated result.
Sortable fields
The list of promotion rules can be sorted by the following fields:
Attributes
Filterable fields
The list of promotion rules can be filtered by the following fields:
Attributes
Relationships
