List all promotions

How to fetch a collection of promotions via API
To fetch a collection of promotions, send a GET request to the /api/promotions endpoint.
Fetching resources
/fetching-resources
Request
GET https://yourdomain.commercelayer.io/api/promotions
Example
Request
Response
Request
The following request fetches a collection of promotions:
curl -X GET \
  https://yourdomain.commercelayer.io/api/promotions/ \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token'
Response
On success, the API responds with a 200 OK status code, returning a paginated collection of resource objects:
{
  "data": [
    {
      "id": "xYZkjABcde",
      "type": "promotions",
      "links": {
        "self": "https://yourdomain.commercelayer.io/api/promotions/xYZkjABcde"
      },
      "attributes": {
        "name": "Personal promotion",
        "starts_at": "2018-01-01T12:00:00.000Z",
        "expires_at": "2018-01-02T12:00:00.000Z",
        "total_usage_limit": "5",
        "total_usage_count": "2",
        "active": "true",
        "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": {
        "market": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/promotions/xYZkjABcde/relationships/market",
            "related": "https://yourdomain.commercelayer.io/api/promotions/xYZkjABcde/market"
          }
        },
        "promotion_rules": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/promotions/xYZkjABcde/relationships/promotion_rules",
            "related": "https://yourdomain.commercelayer.io/api/promotions/xYZkjABcde/promotion_rules"
          }
        },
        "order_amount_promotion_rule": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/promotions/xYZkjABcde/relationships/order_amount_promotion_rule",
            "related": "https://yourdomain.commercelayer.io/api/promotions/xYZkjABcde/order_amount_promotion_rule"
          }
        },
        "sku_list_promotion_rule": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/promotions/xYZkjABcde/relationships/sku_list_promotion_rule",
            "related": "https://yourdomain.commercelayer.io/api/promotions/xYZkjABcde/sku_list_promotion_rule"
          }
        },
        "coupon_codes_promotion_rule": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/promotions/xYZkjABcde/relationships/coupon_codes_promotion_rule",
            "related": "https://yourdomain.commercelayer.io/api/promotions/xYZkjABcde/coupon_codes_promotion_rule"
          }
        },
        "attachments": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/promotions/xYZkjABcde/relationships/attachments",
            "related": "https://yourdomain.commercelayer.io/api/promotions/xYZkjABcde/attachments"
          }
        }
      },
      "meta": {
        "mode": "test"
      }
    },
    {
      "other": "... 9 promotions (first page)"
    }
  ],
  "meta": {
    "record_count": 140,
    "page_count": 14
  },
  "links": {
    "first": "https://yourdomain.commercelayer.io/api/promotions?page[number]=1&page[size]=10",
    "next": "https://yourdomain.commercelayer.io/api/promotions?page[number]=2&page[size]=10",
    "last": "https://yourdomain.commercelayer.io/api/promotions?page[number]=14&page[size]=10"
  }
}
Pagination
/pagination
Sortable attributes
The list of promotions can be sorted by the following attributes:
name
starts_at
expires_at
id
created_at
updated_at
reference
reference_origin
Sorting results
/sorting-results
Resources - Previous
Promotions
Next - Resources
Refunds
Last updated 2 weeks ago