Links

Retrieve a buy x pay y promotion

How to fetch a specific buy x pay y promotion via API
To fetch a single buy x pay y promotion, send a GET request to the /api/buy_x_pay_y_promotions/:id endpoint, where id is the ID of the resource that you want to retrieve.

Request

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

Example

Request
Response
The following request fetches the buy x pay y promotion identified by the id "xYZkjABcde":
curl -g -X GET \
'https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde' \
-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 single resource object:
{
"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"
}
}
}