List all coupons

How to fetch a collection of coupons via API

To fetch a collection of coupons, send a GET request to the /api/coupons endpoint.

Request

GET https://yourdomain.commercelayer.io/api/coupons

Example

Request

The following request fetches a collection of coupons:

curl -g -X GET \
  'https://yourdomain.commercelayer.io/api/coupons/' \
  -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": "coupons",
      "links": {
        "self": "https://yourdomain.commercelayer.io/api/coupons/xYZkjABcde"
      },
      "attributes": {
        "code": "04371af2-70b3-48d7-8f4e-316b374224c3",
        "customer_single_use": false,
        "usage_limit": 50,
        "usage_count": 20,
        "recipient_email": "[e-mail]",
        "expires_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": {
        "promotion_rule": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/coupons/xYZkjABcde/relationships/promotion_rule",
            "related": "https://yourdomain.commercelayer.io/api/coupons/xYZkjABcde/promotion_rule"
          }
        },
        "coupon_recipient": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/coupons/xYZkjABcde/relationships/coupon_recipient",
            "related": "https://yourdomain.commercelayer.io/api/coupons/xYZkjABcde/coupon_recipient"
          }
        },
        "events": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/coupons/xYZkjABcde/relationships/events",
            "related": "https://yourdomain.commercelayer.io/api/coupons/xYZkjABcde/events"
          }
        },
        "tags": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/coupons/xYZkjABcde/relationships/tags",
            "related": "https://yourdomain.commercelayer.io/api/coupons/xYZkjABcde/tags"
          }
        },
        "versions": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/coupons/xYZkjABcde/relationships/versions",
            "related": "https://yourdomain.commercelayer.io/api/coupons/xYZkjABcde/versions"
          }
        }
      },
      "meta": {
        "mode": "test"
      }
    },
    {
      "other": "... 9 coupons (first page)"
    }
  ],
  "meta": {
    "record_count": 140,
    "page_count": 14
  },
  "links": {
    "first": "https://yourdomain.commercelayer.io/api/coupons?page[number]=1&page[size]=10",
    "next": "https://yourdomain.commercelayer.io/api/coupons?page[number]=2&page[size]=10",
    "last": "https://yourdomain.commercelayer.io/api/coupons?page[number]=14&page[size]=10"
  }
}

Remember that when you fetch a list of resources you get paginated result.

Sortable fields

The list of coupons can be sorted by the following fields:

• code

• customer_single_use

• usage_limit

• usage_count

• expires_at

• id

• created_at

• updated_at

• reference

• reference_origin

Filterable fields

The list of coupons can be filtered by the following fields:

Attributes

• code

• customer_single_use

• usage_limit

• usage_count

• expires_at

• id

• created_at

• updated_at

• reference

• reference_origin

• metadata

Relationships

• promotion_rule

• coupon_recipient

• events

• tags