Product Promotion Code Samples
This page is for Developer.
Buy one and get one free
Request
Response
Example request
{"name": "Buy one and get one free","redemption_type": "AUTOMATIC","rules": [{"action": {"gift_item": {"product_id": 130,"quantity": 1}},"apply_once": false,"stop": false,"currency_code": "AUD","condition": {"cart": {"items": {"products": [130]},"minimum_quantity": 1}}}],"notifications": [{"type": "UPSELL","content": "","locations": ["CART_PAGE"]},{"type": "ELIGIBLE","content": "","locations": ["CART_PAGE"]},{"type": "APPLIED","content": "","locations": ["CART_PAGE"]}],"stop": false,"status": "ENABLED","start_date": "2019-02-06T05:00:00+00:00","end_date": "2019-02-09T04:59:59+00:00"}
Buy (X units) of product A and get (Y units) of product B for $ or % off per unit
Request
Response
Example request
{"name": "Buy two X and get 10% off Y","redemption_type": "AUTOMATIC","rules": [{"action": {"cart_items": {"discount": {"percentage_amount": "10"},"strategy": "LEAST_EXPENSIVE","as_total": false,"include_items_considered_by_condition": false,"items": {"products": [130]},"quantity": 1}},"apply_once": false,"stop": false,"condition": {"cart": {"items": {"products": [129]},"minimum_quantity": 1}}}],"notifications": [{"type": "UPSELL","content": "","locations": ["CART_PAGE"]},{"type": "ELIGIBLE","content": "","locations": ["CART_PAGE"]},{"type": "APPLIED","content": "","locations": ["CART_PAGE"]}],"stop": false,"status": "ENABLED"}
Get $ or % off product X
Request
Response
Example request
{"name": "Spend 100 dollars and get 10% off small orbit","redemption_type": "AUTOMATIC","rules": [{"action": {"cart_items": {"discount": {"percentage_amount": "10"},"strategy": "LEAST_EXPENSIVE","as_total": false,"include_items_considered_by_condition": false,"items": {"products": [130]},"quantity": 1}},"apply_once": true,"stop": false,"condition": {"cart": {"minimum_spend": "100"}}}],"notifications": [{"type": "UPSELL","content": "","locations": ["CART_PAGE"]},{"type": "ELIGIBLE","content": "","locations": ["CART_PAGE"]},{"type": "APPLIED","content": "","locations": ["CART_PAGE"]}],"stop": false,"status": "ENABLED"}
Take X% off the most expensive item in the cart
Request
Response
Example request
{"name": "Apply 20% off most expensive cart item","redemption_type": "AUTOMATIC","rules": [{"action": {"cart_items": {"discount": {"percentage_amount": "20"},"quantity": 1,"strategy": "MOST_EXPENSIVE","as_total": false}},"apply_once": true,"stop": false}],"notifications": [{"type": "UPSELL","content": "<div> </div>","locations": ["CART_PAGE"]},{"type": "ELIGIBLE","content": "<div> </div>","locations": ["CART_PAGE"]},{"type": "APPLIED","content": "<div> </div>","locations": ["CART_PAGE"]}],"stop": false,"current_uses": 0,"max_uses": null,"start_date": "2019-01-31T05:00:00+00:00","end_date": null,"status": "ENABLED"}
Buy X product variant and get X product variant free
Request
Response
Example request
{"name": "Buy X product variant and get X product variant free","redemption_type": "AUTOMATIC","rules": [{"action": {"gift_item": {"variant_id": 151,"quantity": 1}},"apply_once": false,"stop": false,"currency_code": "GBP","condition": {"cart": {"items": {"variants": [139]},"minimum_quantity": 2}}}],"notifications": [{"type": "UPSELL","content": "<div> </div>\r\n<div> </div>","locations": ["CART_PAGE"]},{"type": "ELIGIBLE","content": "<div> </div>\r\n<div> </div>","locations": ["CART_PAGE"]},{"type": "APPLIED","content": "<div> </div>\r\n<div> </div>","locations": ["CART_PAGE"]}],"stop": false,"status": "ENABLED"}
Amount off
Request
Response
Example request
{"name": "US $50 off a specific product","redemption_type": "AUTOMATIC","currency_code": "USD","rules": [{"apply_once": false,"condition": {"cart": {"items": {"products": [129]},"minimum_quantity": 1}},"action": {"cart_items": {"discount": {"fixed_amount": "50"},"items": {"products": [130]},"quantity": 1,"include_items_considered_by_condition": true}}}]}
Percentage off
Request
Response
Example request
{"name": "US 15% off a specific product","redemption_type": "AUTOMATIC","rules": [{"apply_once": false,"condition": {"cart": {"items": {"products": [129]},"minimum_quantity": 1}},"action": {"cart_items": {"discount": {"percentage_amount": "75"},"items": {"products": [130]},"quantity": 1,"include_items_considered_by_condition": true}}}]}
Buy three for the price of two
Request
Response
Example request
{"name": "Buy three for the price of two","redemption_type": "AUTOMATIC","rules": [{"apply_once": false,"condition": {"cart": {"items": {"products": [129]},"minimum_quantity": 2}},"action": {"cart_items": {"discount": {"percentage_amount": "100"},"items": {"products": [130]},"quantity": 1}}}]}
Buy extra-small or medium item and get free shipping to zone id 1 (Product Options Item Matcher)
Request
Response
Example request
{"name": "Buy extra-small or medium item and get free shipping to zone id 1","redemption_type": "AUTOMATIC","rules": [{"condition":{"cart":{"items": {"product_option": {"type": "string_match","name": "Size","values": ["XS","M"]}},"minimum_quantity": 1}},"action":{"shipping":{"free_shipping":true,"zone_ids":[1]}}}]}
Buy extra-small blue or medium blue item and receive free shipping (Product Options Item Matcher)
Request
Response
Example request
{"name": "Buy extra-small blue or medium blue item and receive free shipping","redemption_type": "AUTOMATIC","rules": [{"condition": {"cart": {"items": {{"product_option": {"type": "string_match","name": "Size","values": ["XS","M"]}},{"product_option": {"type": "string_match","name": "Color","values": ["Blue"]}}},"minimum_quantity": 1}},"action": {"shipping": {"free_shipping": true,"zone_ids": [1]}}}]}
Take 20% off all men’s clothing (Product Custom Field Item Matcher)
Request
Response
Example request
{"name": "Apply 20% off all male clothing","redemption_type": "AUTOMATIC","rules": [{"action": {"cart_items": {"discount": {"percentage_amount": "20"},"items": {"product_custom_field": {"name": "Gender","values": ["Mens"]}}}}}]}
Get $1 off each product price up to $5 (limited discount maximum)
Request
Response
Example request
{"can_be_used_with_other_promotions": true,"channels": [],"coupon_overrides_automatic_when_offering_higher_discounts": false,"currency_code": "USD","current_uses": 0,"created_from": "api","customer": {"group_ids": [],"minimum_order_count": 0,"segments": null,"excluded_group_ids": []},"end_date": null,"max_uses": null,"name": "Discount on products - fixed amount - each product price - api","notifications": [],"redemption_type": "AUTOMATIC","rules": [{"action": {"cart_items": {"add_free_item": false,"discount": {"fixed_amount": "1"},"maximum_allowed_discount_amount": "5","exclude_items_on_sale": false,"include_items_considered_by_condition": false,"as_total": false,"strategy": "LEAST_EXPENSIVE"}},"apply_once": true,"stop": false}],"schedule": null,"shipping_address": null,"start_date": "2025-10-15T00:00:00-05:00","status": "ENABLED","display_name": "Get $1 off each product price upto $5"}
Get 10% off each product price up to $20 (limited discount maximum)
Request
Response
Example request
{"can_be_used_with_other_promotions": true,"channels": [],"coupon_overrides_automatic_when_offering_higher_discounts": false,"currency_code": "USD","current_uses": 0,"created_from": "api","customer": {"group_ids": [],"minimum_order_count": 0,"segments": null,"excluded_group_ids": []},"end_date": null,"max_uses": null,"name": "discount on products - percent - each product price","notifications": [],"redemption_type": "AUTOMATIC","rules": [{"action": {"cart_items": {"add_free_item": false,"discount": {"percentage_amount": "10"},"maximum_allowed_discount_amount": "20","exclude_items_on_sale": false,"include_items_considered_by_condition": false,"as_total": false,"strategy": "LEAST_EXPENSIVE"}},"apply_once": true,"stop": false}],"schedule": null,"shipping_address": null,"start_date": "2025-10-15T00:00:00-05:00","status": "ENABLED","display_name": "Get 10% off each product price upto $20"}