Create a fixed amount promotion

How to create a fixed amount promotion via API

To create a new fixed amount promotion, send a POST request to the /api/fixed_amount_promotions endpoint, passing the resource arguments in the request body.

Request

POST https://yourdomain.commercelayer.io/api/fixed_amount_promotions

Arguments

Body ParameterTypeRequired

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.reference

string

Optional

attributes.reference_origin

string

Optional

attributes.metadata

object

Optional

attributes._disable

boolean

Optional

attributes._enable

boolean

Optional

attributes.fixed_amount_cents

integer

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 fixed amount promotion:

curl -g -X POST \
  'https://yourdomain.commercelayer.io/api/fixed_amount_promotions' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "fixed_amount_promotions",
    "attributes": {
      "name": "Personal promotion",
      "starts_at": "2018-01-01T12:00:00.000Z",
      "expires_at": "2018-01-02T12:00:00.000Z",
      "fixed_amount_cents": 1000
    }
  }
}'

Last updated