Brand Promotion Code Samples
Spend $X in brand X and get free shipping to X shipping zones
Request
Response
Example request
{ "name": "Order $100 of this common good brand and get free shipping", "redemption_type": "AUTOMATIC", "rules": [ { "action": { "shipping": { "free_shipping": true, "zone_ids": [ 1, 3 ] } }, "apply_once": true, "stop": false, "condition": { "cart": { "items": { "brands": [ 37 ] }, "minimum_quantity": 1, "minimum_spend": 100 } } } ], "notifications": [ { "type": "UPSELL", "content": "Get Free Shipping for Common Good Upsell", "locations": [ "CART_PAGE" ] }, { "type": "ELIGIBLE", "content": "On the Cart Page, Eligible", "locations": [ "CART_PAGE" ] }, { "type": "APPLIED", "content": "Applied Cart Page", "locations": [ "CART_PAGE" ] } ], "stop": false, "status": "ENABLED" }
Apply a $ or % discount to each item in one or more brands (AND, NOT operators)
Request
Response
Example request
{ "name": "Apply a $ or % discount to each item in one or more brands", "redemption_type": "AUTOMATIC", "rules": [ { "action": { "cart_items": { "discount": { "percentage_amount": "15" }, "strategy": "LEAST_EXPENSIVE", "as_total": false, "include_items_considered_by_condition": false, "items": { "and": [ { "brands": [ 38, 37, 36, 35 ] }, { "not": { "categories": [ 19 ] } } ] } } }, "apply_once": true, "stop": false } ], "notifications": [ { "type": "UPSELL", "content": "Get 15% off in Common Good, Chemex, Barr-Co and Kinfolk.\r\n<div> </div>", "locations": [ "HOME_PAGE", "PRODUCT_PAGE", "CART_PAGE" ] }, { "type": "ELIGIBLE", "content": "You are eligible for 15% off!\r\n<div> </div>", "locations": [ "CART_PAGE" ] }, { "type": "APPLIED", "content": "Congratulations you have earned 15% off.", "locations": [ "CART_PAGE" ] } ], "stop": false, "status": "ENABLED" }
Spend X amount in brand Y, get X% off in brand Y
Request
Response
Example request
1 { 2 "name": "Spend X amount in brand Y and get X% off in brand Y", 3 "redemption_type": "AUTOMATIC", 4 "rules": [ 5 { 6 "action": { 7 "cart_items": { 8 "discount": { 9 "percentage_amount": "10" 10 }, 11 "strategy": "LEAST_EXPENSIVE", 12 "as_total": true, 13 "include_items_considered_by_condition": true, 14 "items": { 15 "brands": [ 16 36 17 ] 18 } 19 } 20 }, 21 "apply_once": true, 22 "stop": false, 23 "condition": { 24 "cart": { 25 "items": { 26 "brands": [ 27 36 28 ] 29 }, 30 "minimum_spend": "200", 31 "minimum_quantity": 1 32 } 33 } 34 } 35 ], 36 "notifications": [ 37 { 38 "type": "UPSELL", 39 "content": "<div> </div>", 40 "locations": [ 41 "CART_PAGE" 42 ] 43 }, 44 { 45 "type": "ELIGIBLE", 46 "content": "<div> </div>", 47 "locations": [ 48 "CART_PAGE" 49 ] 50 }, 51 { 52 "type": "APPLIED", 53 "content": "<div> </div>", 54 "locations": [ 55 "CART_PAGE" 56 ] 57 } 58 ], 59 "stop": false, 60 "status": "ENABLED" 61 }
Buy two items in a brand and get the cheapest one free
Request
Response
Example request
1 { 2 "name": "Buy two items in brand and get the cheapest one free", 3 "redemption_type": "AUTOMATIC", 4 "rules": [ 5 { 6 "apply_once": false, 7 "condition": { 8 "cart": { 9 "items": { 10 "brands": [ 11 36 12 ] 13 }, 14 "minimum_quantity": 2 15 } 16 }, 17 "action": { 18 "cart_items": { 19 "strategy": "LEAST_EXPENSIVE", 20 "include_items_considered_by_condition": true, 21 "discount": { 22 "percentage_amount": "100" 23 }, 24 "items": { 25 "brands": [ 26 36 27 ] 28 }, 29 "quantity": 1 30 } 31 } 32 } 33 ] 34 }
Buy two brand items and get the most expensive one at 50% off
Request
Response
Example request
1 { 2 "name": "Buy two brand items and get the most expensive one at 50% off", 3 "redemption_type": "AUTOMATIC", 4 "rules": [ 5 { 6 "apply_once": false, 7 "condition": { 8 "cart": { 9 "items": { 10 "brands": [ 11 36 12 ] 13 }, 14 "minimum_quantity": 2 15 } 16 }, 17 "action": { 18 "cart_items": { 19 "strategy": "MOST_EXPENSIVE", 20 "include_items_considered_by_condition": true, 21 "discount": { 22 "percentage_amount": "50" 23 }, 24 "items": { 25 "brands": [ 26 36 27 ] 28 }, 29 "quantity": 1 30 } 31 } 32 } 33 ] 34 }
Buy two brand items and get the most expensive one at $50 off
Request
Response
Example request
1 { 2 "name": "Buy two brand items and get the most expensive one at $50 off", 3 "redemption_type": "AUTOMATIC", 4 "rules": [ 5 { 6 "apply_once": false, 7 "condition": { 8 "cart": { 9 "items": { 10 "brands": [ 11 36 12 ] 13 }, 14 "minimum_quantity": 2 15 } 16 }, 17 "action": { 18 "cart_items": { 19 "strategy": "MOST_EXPENSIVE", 20 "include_items_considered_by_condition": true, 21 "discount": { 22 "fixed_amount": "50" 23 }, 24 "items": { 25 "brands": [ 26 36 27 ] 28 }, 29 "quantity": 1 30 } 31 } 32 } 33 ] 34 }
Spend $X on brand Y and get product Z for free
Request
Response
Example request
1 { 2 "name": "Spend $X on brand Y and get product Z for free", 3 "redemption_type": "AUTOMATIC", 4 "rules": [ 5 { 6 "apply_once": false, 7 "condition": { 8 "cart": { 9 "items": { 10 "brands": [ 11 38 12 ] 13 }, 14 "minimum_spend": 200 15 } 16 }, 17 "action": { 18 "gift_item": { 19 "product_id": 130, 20 "quantity": 1 21 } 22 } 23 } 24 ] 25 }