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
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'
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
exclusive
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
Last updated