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

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'

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:

Attributes

  • name

  • type

  • currency_code

  • exclusive

  • priority

  • starts_at

  • expires_at

  • total_usage_limit

  • total_usage_count

  • id

  • created_at

  • updated_at

  • reference

  • reference_origin

  • disabled_at

  • x

  • y

Relationships

  • market

  • sku_list

Filterable fields

The list of buy x pay y 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

  • created_at

  • updated_at

  • reference

  • reference_origin

  • metadata

  • disabled_at

  • 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

Last updated