To create a new free gift promotion, send a POST request to the /api/free_gift_promotions endpoint, passing the resource arguments in the request body.
Request
POST https://yourdomain.commercelayer.io/api/free_gift_promotions
Arguments
Body Parameter
Type
Required
type
string
Required
attributes._disable
boolean
Optional
attributes._enable
boolean
Optional
attributes.currency_code
string
Optional
attributes.exclusive
boolean
Optional
attributes.expires_at
datetime
Required
attributes.max_quantity
integer
Optional, default is '1'
attributes.metadata
object
Optional
attributes.name
string
Required
attributes.priority
integer
Optional
attributes.reference
string
Optional
attributes.reference_origin
string
Optional
attributes.starts_at
datetime
Required
attributes.total_usage_limit
integer
Optional
relationships.coupon_codes_promotion_rule
object
Optional
relationships.custom_promotion_rule
object
Optional
relationships.market
object
Optional
relationships.order_amount_promotion_rule
object
Optional
relationships.sku_list
object
Required
relationships.sku_list_promotion_rule
object
Optional
relationships.tags
array
Optional
Example
The following request creates a new free gift promotion: