List all external promotions

How to fetch a collection of external promotions via API

To fetch a collection of external promotions, send a GET request to the /api/external_promotions endpoint.

Request

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

Example

Request

The following request fetches a collection of external promotions:

curl -g -X GET \
  'https://yourdomain.commercelayer.io/api/external_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": "external_promotions",
      "links": {
        "self": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde"
      },
      "attributes": {
        "name": "Personal promotion",
        "type": "percentage_discount_promotions",
        "currency_code": "EUR",
        "exclusive": true,
        "priority": 2,
        "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,
        "status": "pending",
        "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"
        },
        "promotion_url": "https://external_promotion.yourbrand.com",
        "shared_secret": "1c0994cc4e996e8c6ee56a2198f66f3c"
      },
      "relationships": {
        "market": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/relationships/market",
            "related": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/market"
          }
        },
        "promotion_rules": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/relationships/promotion_rules",
            "related": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/promotion_rules"
          }
        },
        "order_amount_promotion_rule": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/relationships/order_amount_promotion_rule",
            "related": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/order_amount_promotion_rule"
          }
        },
        "sku_list_promotion_rule": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/relationships/sku_list_promotion_rule",
            "related": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/sku_list_promotion_rule"
          }
        },
        "coupon_codes_promotion_rule": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/relationships/coupon_codes_promotion_rule",
            "related": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/coupon_codes_promotion_rule"
          }
        },
        "custom_promotion_rule": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/relationships/custom_promotion_rule",
            "related": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/custom_promotion_rule"
          }
        },
        "sku_list": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/relationships/sku_list",
            "related": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/sku_list"
          }
        },
        "coupons": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/relationships/coupons",
            "related": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/coupons"
          }
        },
        "attachments": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/relationships/attachments",
            "related": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/attachments"
          }
        },
        "events": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/relationships/events",
            "related": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/events"
          }
        },
        "tags": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/relationships/tags",
            "related": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/tags"
          }
        },
        "versions": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/relationships/versions",
            "related": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/versions"
          }
        },
        "skus": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/relationships/skus",
            "related": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/skus"
          }
        }
      },
      "meta": {
        "mode": "test",
        "organization_id": "xRRkjDFafe",
        "trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
      }
    },
    {
      "other": "... 9 external_promotions (first page)"
    }
  ],
  "meta": {
    "record_count": 140,
    "page_count": 14
  },
  "links": {
    "first": "https://yourdomain.commercelayer.io/api/external_promotions?page[number]=1&page[size]=10",
    "next": "https://yourdomain.commercelayer.io/api/external_promotions?page[number]=2&page[size]=10",
    "last": "https://yourdomain.commercelayer.io/api/external_promotions?page[number]=14&page[size]=10"
  }
}

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

Sortable fields

The list of external promotions can be sorted by the following fields:

Attributes

• name

• type

• currency_code

• exclusive

• priority

• starts_at

• expires_at

• total_usage_limit

• total_usage_count

• id

• disabled_at

• created_at

• updated_at

• reference

• reference_origin

• circuit_state

• circuit_failure_count

Relationships

• market

• sku_list

Filterable fields

The list of external promotions can be filtered by the following fields:

Attributes

• name

• type

• currency_code

• priority

• starts_at

• expires_at

• total_usage_limit

• total_usage_count

• id

• disabled_at

• created_at

• updated_at

• reference

• reference_origin

• metadata

• circuit_state

• circuit_failure_count

Relationships

• market

• promotion_rules

• order_amount_promotion_rule

• sku_list_promotion_rule

• coupon_codes_promotion_rule

• custom_promotion_rule

• sku_list

• coupons

• attachments

• events

• tags