To create a new free shipping promotion, send a POST
request to the /api/free_shipping_promotions
endpoint, passing the resource arguments in the request body.
POST https://yourdomain.commercelayer.io/api/free_shipping_promotions
Body Parameter | Type | Required |
type |
| Required |
attributes.name |
| Required |
attributes.starts_at |
| Required |
attributes.expires_at |
| Required |
attributes.total_usage_limit |
| Required |
attributes.reference |
| Optional |
attributes.reference_origin |
| Optional |
attributes.metadata |
| Optional |
relationships.market |
| Required, unless in scope |
relationships.promotion_rules |
| Optional |
relationships.order_amount_promotion_rule |
| Optional |
relationships.sku_list_promotion_rule |
| Optional |
relationships.coupon_codes_promotion_rule |
| Optional |
The following request creates a new free shipping promotion:
curl -X POST \https://yourdomain.commercelayer.io/api/free_shipping_promotions \-H 'Accept: application/vnd.api+json' \-H 'Authorization: Bearer your-access-token' \-H 'Content-Type: application/vnd.api+json' \-d '{"data": {"type": "free_shipping_promotions","attributes": {"name": "Personal promotion","starts_at": "2018-01-01T12:00:00.000Z","expires_at": "2018-01-02T12:00:00.000Z","total_usage_limit": "5"},"relationships": {"market": {"data": {"type": "markets","id": "QWERtyUpBa"}}}}}'
On success, the API responds with a 201 Created
status code, returning the created resource object:
{"data": {"id": "xYZkjABcde","type": "free_shipping_promotions","links": {"self": "https://yourdomain.commercelayer.io/api/free_shipping_promotions/xYZkjABcde"},"attributes": {"name": "Personal promotion","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,"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","metadata": {"foo": "bar"}},"relationships": {"market": {"links": {"self": "https://yourdomain.commercelayer.io/api/free_shipping_promotions/xYZkjABcde/relationships/market","related": "https://yourdomain.commercelayer.io/api/free_shipping_promotions/xYZkjABcde/market"}},"promotion_rules": {"links": {"self": "https://yourdomain.commercelayer.io/api/free_shipping_promotions/xYZkjABcde/relationships/promotion_rules","related": "https://yourdomain.commercelayer.io/api/free_shipping_promotions/xYZkjABcde/promotion_rules"}},"order_amount_promotion_rule": {"links": {"self": "https://yourdomain.commercelayer.io/api/free_shipping_promotions/xYZkjABcde/relationships/order_amount_promotion_rule","related": "https://yourdomain.commercelayer.io/api/free_shipping_promotions/xYZkjABcde/order_amount_promotion_rule"}},"sku_list_promotion_rule": {"links": {"self": "https://yourdomain.commercelayer.io/api/free_shipping_promotions/xYZkjABcde/relationships/sku_list_promotion_rule","related": "https://yourdomain.commercelayer.io/api/free_shipping_promotions/xYZkjABcde/sku_list_promotion_rule"}},"coupon_codes_promotion_rule": {"links": {"self": "https://yourdomain.commercelayer.io/api/free_shipping_promotions/xYZkjABcde/relationships/coupon_codes_promotion_rule","related": "https://yourdomain.commercelayer.io/api/free_shipping_promotions/xYZkjABcde/coupon_codes_promotion_rule"}},"attachments": {"links": {"self": "https://yourdomain.commercelayer.io/api/free_shipping_promotions/xYZkjABcde/relationships/attachments","related": "https://yourdomain.commercelayer.io/api/free_shipping_promotions/xYZkjABcde/attachments"}}},"meta": {"mode": "test"}}}