Create a flex promotion
How to create a flex promotion via API
To create a new flex promotion, send a POST request to the /api/flex_promotions endpoint, passing the resource arguments in the request body.
Request
POST https://yourdomain.commercelayer.io/api/flex_promotions
Arguments
type
string
Required
attributes.name
string
Required
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.rules
object
Required
attributes._disable
boolean
Optional
attributes._enable
boolean
Optional
attributes.reference
string
Optional
attributes.reference_origin
string
Optional
attributes.metadata
object
Optional
relationships.coupon_codes_promotion_rule
object
Optional
relationships.tags
array
Optional
Example
The following request creates a new flex promotion:
curl -g -X POST \
'https://yourdomain.commercelayer.io/api/flex_promotions' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token' \
-H 'Content-Type: application/vnd.api+json' \
-d '{
"data": {
"type": "flex_promotions",
"attributes": {
"name": "Personal promotion",
"starts_at": "2018-01-01T12:00:00.000Z",
"expires_at": "2018-01-02T12:00:00.000Z",
"rules": {}
}
}
}'On success, the API responds with a 201 Created status code, returning the created resource object:
{
"data": {
"id": "XAyRWNUzyN",
"type": "flex_promotions",
"links": {
"self": "https://yourdomain.commercelayer.io/api/flex_promotions/XAyRWNUzyN"
},
"attributes": {
"name": "Personal promotion",
"type": "percentage_discount_promotions",
"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,
"status": "pending",
"rules": {},
"rule_outcomes": [],
"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",
"resource_payload": {},
"metadata": {
"foo": "bar"
}
},
"relationships": {
"coupon_codes_promotion_rule": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/flex_promotions/XAyRWNUzyN/relationships/coupon_codes_promotion_rule",
"related": "https://yourdomain.commercelayer.io/api/flex_promotions/XAyRWNUzyN/coupon_codes_promotion_rule"
}
},
"coupons": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/flex_promotions/XAyRWNUzyN/relationships/coupons",
"related": "https://yourdomain.commercelayer.io/api/flex_promotions/XAyRWNUzyN/coupons"
}
},
"attachments": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/flex_promotions/XAyRWNUzyN/relationships/attachments",
"related": "https://yourdomain.commercelayer.io/api/flex_promotions/XAyRWNUzyN/attachments"
}
},
"events": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/flex_promotions/XAyRWNUzyN/relationships/events",
"related": "https://yourdomain.commercelayer.io/api/flex_promotions/XAyRWNUzyN/events"
}
},
"tags": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/flex_promotions/XAyRWNUzyN/relationships/tags",
"related": "https://yourdomain.commercelayer.io/api/flex_promotions/XAyRWNUzyN/tags"
}
},
"versions": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/flex_promotions/XAyRWNUzyN/relationships/versions",
"related": "https://yourdomain.commercelayer.io/api/flex_promotions/XAyRWNUzyN/versions"
}
},
"event_stores": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/flex_promotions/XAyRWNUzyN/relationships/event_stores",
"related": "https://yourdomain.commercelayer.io/api/flex_promotions/XAyRWNUzyN/event_stores"
}
}
},
"meta": {
"mode": "test",
"organization_id": "xRRkjDFafe",
"trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
}
}
}Last updated

