Create an external promotion
How to create an external promotion via API
To create a new external promotion, send a POST
request to the /api/external_promotions
endpoint, passing the resource arguments in the request body.
Request
POST https://yourdomain.commercelayer.io/api/external_promotions
Arguments
type
string
Required
attributes.name
string
Required
attributes.currency_code
string
Optional
attributes.exclusive
boolean
Optional
attributes.priority
integer
Optional
attributes.starts_at
datetime
Required
attributes.expires_at
datetime
Required
attributes.total_usage_limit
integer
Optional
attributes._disable
boolean
Optional
attributes._enable
boolean
Optional
attributes.reference
string
Optional
attributes.reference_origin
string
Optional
attributes.metadata
object
Optional
attributes.promotion_url
string
Required
relationships.market
object
Optional
relationships.order_amount_promotion_rule
object
Optional
relationships.sku_list_promotion_rule
object
Optional
relationships.coupon_codes_promotion_rule
object
Optional
relationships.custom_promotion_rule
object
Optional
relationships.sku_list
object
Optional
relationships.tags
array
Optional
Example
The following request creates a new external promotion:
curl -g -X POST \
'https://yourdomain.commercelayer.io/api/external_promotions' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token' \
-H 'Content-Type: application/vnd.api+json' \
-d '{
"data": {
"type": "external_promotions",
"attributes": {
"name": "Personal promotion",
"starts_at": "2018-01-01T12:00:00.000Z",
"expires_at": "2018-01-02T12:00:00.000Z",
"promotion_url": "https://external_promotion.yourbrand.com"
}
}
}'
Last updated