Links

List all buy x pay y promotions

How to fetch a collection of buy x pay y promotions via API
To fetch a collection of buy x pay y promotions, send a GET request to the /api/buy_x_pay_y_promotions endpoint.

Request

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

Example

Request
Response
The following request fetches a collection of buy x pay y promotions:
curl -g -X GET \
'https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/' \
-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": "buy_x_pay_y_promotions",
"links": {
"self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde"
},
"attributes": {
"name": "Personal promotion",
"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,
"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"
},
"x": 3,
"y": 2,
"cheapest_free": true
},
"relationships": {
"market": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/relationships/market",
"related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/market"
}
},
"promotion_rules": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/relationships/promotion_rules",
"related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/promotion_rules"
}
},
"order_amount_promotion_rule": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/relationships/order_amount_promotion_rule",
"related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/order_amount_promotion_rule"
}
},
"sku_list_promotion_rule": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/relationships/sku_list_promotion_rule",
"related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/sku_list_promotion_rule"
}
},
"coupon_codes_promotion_rule": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/relationships/coupon_codes_promotion_rule",
"related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/coupon_codes_promotion_rule"
}
},
"custom_promotion_rule": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/relationships/custom_promotion_rule",
"related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/custom_promotion_rule"
}
},
"sku_list": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/relationships/sku_list",
"related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/sku_list"
}
},
"coupons": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/relationships/coupons",
"related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/coupons"
}
},
"attachments": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/relationships/attachments",
"related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/attachments"
}
},
"events": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/relationships/events",
"related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/events"
}
},
"tags": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/relationships/tags",
"related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/tags"
}
},
"versions": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/relationships/versions",
"related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/versions"
}
},
"skus": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/relationships/skus",
"related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/skus"
}
}
},
"meta": {
"mode": "test"
}
},
{
"other": "... 9 buy_x_pay_y_promotions (first page)"
}
],
"meta": {
"record_count": 140,
"page_count": 14
},
"links": {
"first": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions?page[number]=1&page[size]=10",
"next": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions?page[number]=2&page[size]=10",
"last": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_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 buy x pay y promotions can be sorted by the following fields:
  • name
  • currency_code
  • exclusive
  • priority
  • starts_at
  • expires_at
  • total_usage_limit
  • total_usage_count
  • disabled_at
  • id
  • created_at
  • updated_at
  • reference
  • reference_origin
  • x
  • y

Filterable fields

The list of buy x pay y promotions can be filtered by the following fields:

Attributes

  • name
  • currency_code
  • starts_at
  • expires_at
  • total_usage_limit
  • total_usage_count
  • disabled_at
  • id
  • created_at
  • updated_at
  • reference
  • reference_origin
  • metadata
  • x
  • y

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