Promotions

Promotions are incentives offered to shoppers to promote the purchase of items in a store. A store’s marketer creates promotions and defines a set of conditions that must be met before the promotion is applied to a given shopper. Promotions may trigger discounts or may trigger other incentives such as free items. When a promotion triggers a discount, the discounts are automatically applied to the item price, cart line item price, shipping option cost, line items total, cart total, and the order total.

Promotions are linked to a number of different resources:

• Promotions - The promotions resource provides a list of all the promotions available for the store
• Items - Promotions are linked to items when a promotion exists for that item and the shopper is eligible to receive the promotion
• Carts - Promotions are linked to carts when the contents of the shopper’s cart meet the conditions of the promotion
• Cart line items - Promotions are linked to cart line items when the line item meets the conditions of the promotion
• Shipping options - Promotions are linked to shipping options on an order shipment when the option meets the conditions of the promotion
• Purchases - Promotions are linked to purchases when the purchase had promotions applied to it
• Coupons - Promotion are linked to a coupon when the coupon triggered the promotions to apply

Read Applied Item Promotions

Retrieve promotions applied to an item.

Workflow

1. Start with item
2. GET the link with rel: appliedpromotions
3. GET the link with rel: element
4. Render the response

Response Fields

Type: promotions.promotion

Name	Description	Type
name	The promotion identifier.	string
display-name	The promotion’s localized name, intended for display in the client application.	string
display-description	The promotion’s localized marketing description, intended for display in the client application.	string
display-conditions	The promotion’s localized terms and conditions, intended for display in the client application.	string

Read Applied Cart Promotions

Retrieve promotions applied to a cart.

Workflow

1. Start with cart
2. GET the link with rel: appliedpromotions
3. GET the link with rel: element
4. Render the response

Response Fields

Type: promotions.promotion

Name	Description	Type
name	The promotion identifier.	string
display-name	The promotion’s localized name, intended for display in the client application.	string
display-description	The promotion’s localized marketing description, intended for display in the client application.	string
display-conditions	The promotion’s localized terms and conditions, intended for display in the client application.	string

Read Applied Cart Line Item Promotions

Retrieve the promotions applied to a cart line item.

Workflow

1. Start with line-item
2. GET the link with rel: appliedpromotions
3. GET the link with rel: element
4. Render the response

Response Fields

Type: promotions.promotion

Name	Description	Type
name	The promotion identifier.	string
display-name	The promotion’s localized name, intended for display in the client application.	string
display-description	The promotion’s localized marketing description, intended for display in the client application.	string
display-conditions	The promotion’s localized terms and conditions, intended for display in the client application.	string

Read Applied Shipping Option Promotions

Retrieve promotions applied to a shipping option.

Workflow

1. Start with shipping-option
2. GET the link with rel: appliedpromotions
3. GET the link with rel: element
4. Render the response

Response Fields

Type: promotions.promotion

Name	Description	Type
name	The promotion identifier.	string
display-name	The promotion’s localized name, intended for display in the client application.	string
display-description	The promotion’s localized marketing description, intended for display in the client application.	string
display-conditions	The promotion’s localized terms and conditions, intended for display in the client application.	string

Read Promotions Triggered By Order Coupon

Retrieve a promotion trigged by a coupon on an order.

Workflow

1. Start with order-coupon
2. GET the link with rel: promotion
3. Render the response

Response Fields

Type: promotions.promotion

Name	Description	Type
name	The promotion identifier.	string
display-name	The promotion’s localized name, intended for display in the client application.	string
display-description	The promotion’s localized marketing description, intended for display in the client application.	string
display-conditions	The promotion’s localized terms and conditions, intended for display in the client application.	string

Read Applied Purchase Promotions

Retrieve promotions applied to a purchase.

Workflow

1. Start with purchase
2. GET the link with rel: appliedpromotions
3. GET the link with rel: element
4. Render the response

Response Fields

Type: promotions.promotion

Name	Description	Type
name	The promotion identifier.	string
display-name	The promotion’s localized name, intended for display in the client application.	string
display-description	The promotion’s localized marketing description, intended for display in the client application.	string
display-conditions	The promotion’s localized terms and conditions, intended for display in the client application.	string

Read Promotions Triggered By Purchase Coupon

Retrieve a promotion trigged by a coupon on a purchase.

Workflow

1. Start with purchase-coupon
2. GET the link with rel: promotion
3. Render the response

Response Fields

Type: promotions.promotion

Name	Description	Type
name	The promotion identifier.	string
display-name	The promotion’s localized name, intended for display in the client application.	string
display-description	The promotion’s localized marketing description, intended for display in the client application.	string
display-conditions	The promotion’s localized terms and conditions, intended for display in the client application.	string