Retrieve a free gift promotion
GET https://{{subdomain}}.commercelayer.io/api/free_gift_promotions/{{free_gift_promotion_id}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Authorization | string |
RESPONSES
status: OK
{"data":{"id":"xYZkjABcde","type":"free_gift_promotions","links":{"self":"https://yourdomain.commercelayer.io/api/free_gift_promotions/xYZkjABcde"},"attributes":{"name":"Personal promotion","type":"percentage_discount_promotions","currency_code":"EUR","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","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","metadata":{"foo":"bar"},"max_quantity":3},"relationships":{"market":{"links":{"self":"https://yourdomain.commercelayer.io/api/free_gift_promotions/xYZkjABcde/relationships/market","related":"https://yourdomain.commercelayer.io/api/free_gift_promotions/xYZkjABcde/market"}},"promotion_rules":{"links":{"self":"https://yourdomain.commercelayer.io/api/free_gift_promotions/xYZkjABcde/relationships/promotion_rules","related":"https://yourdomain.commercelayer.io/api/free_gift_promotions/xYZkjABcde/promotion_rules"}},"order_amount_promotion_rule":{"links":{"self":"https://yourdomain.commercelayer.io/api/free_gift_promotions/xYZkjABcde/relationships/order_amount_promotion_rule","related":"https://yourdomain.commercelayer.io/api/free_gift_promotions/xYZkjABcde/order_amount_promotion_rule"}},"sku_list_promotion_rule":{"links":{"self":"https://yourdomain.commercelayer.io/api/free_gift_promotions/xYZkjABcde/relationships/sku_list_promotion_rule","related":"https://yourdomain.commercelayer.io/api/free_gift_promotions/xYZkjABcde/sku_list_promotion_rule"}},"coupon_codes_promotion_rule":{"links":{"self":"https://yourdomain.commercelayer.io/api/free_gift_promotions/xYZkjABcde/relationships/coupon_codes_promotion_rule","related":"https://yourdomain.commercelayer.io/api/free_gift_promotions/xYZkjABcde/coupon_codes_promotion_rule"}},"custom_promotion_rule":{"links":{"self":"https://yourdomain.commercelayer.io/api/free_gift_promotions/xYZkjABcde/relationships/custom_promotion_rule","related":"https://yourdomain.commercelayer.io/api/free_gift_promotions/xYZkjABcde/custom_promotion_rule"}},"sku_list":{"links":{"self":"https://yourdomain.commercelayer.io/api/free_gift_promotions/xYZkjABcde/relationships/sku_list","related":"https://yourdomain.commercelayer.io/api/free_gift_promotions/xYZkjABcde/sku_list"}},"coupons":{"links":{"self":"https://yourdomain.commercelayer.io/api/free_gift_promotions/xYZkjABcde/relationships/coupons","related":"https://yourdomain.commercelayer.io/api/free_gift_promotions/xYZkjABcde/coupons"}},"attachments":{"links":{"self":"https://yourdomain.commercelayer.io/api/free_gift_promotions/xYZkjABcde/relationships/attachments","related":"https://yourdomain.commercelayer.io/api/free_gift_promotions/xYZkjABcde/attachments"}},"events":{"links":{"self":"https://yourdomain.commercelayer.io/api/free_gift_promotions/xYZkjABcde/relationships/events","related":"https://yourdomain.commercelayer.io/api/free_gift_promotions/xYZkjABcde/events"}},"tags":{"links":{"self":"https://yourdomain.commercelayer.io/api/free_gift_promotions/xYZkjABcde/relationships/tags","related":"https://yourdomain.commercelayer.io/api/free_gift_promotions/xYZkjABcde/tags"}},"versions":{"links":{"self":"https://yourdomain.commercelayer.io/api/free_gift_promotions/xYZkjABcde/relationships/versions","related":"https://yourdomain.commercelayer.io/api/free_gift_promotions/xYZkjABcde/versions"}},"skus":{"links":{"self":"https://yourdomain.commercelayer.io/api/free_gift_promotions/xYZkjABcde/relationships/skus","related":"https://yourdomain.commercelayer.io/api/free_gift_promotions/xYZkjABcde/skus"}}},"meta":{"mode":"test"}}}