Skip to main content

The container that defines the fields for the details of an item promotion.

Types that use Promotion

LineItemOrderLineItem

Calls that use Promotion

POST
/checkout_session/{checkoutSessionId}/apply_coupon
GET
/checkout_session/{checkoutSessionId}
POST
/checkout_session/initiate
POST
/checkout_session/{checkoutSessionId}/remove_coupon
POST
/checkout_session/{checkoutSessionId}/update_add_on_services_status
POST
/checkout_session/{checkoutSessionId}/update_payment_info
POST
/checkout_session/{checkoutSessionId}/update_quantity
POST
/checkout_session/{checkoutSessionId}/update_shipping_address
POST
/checkout_session/{checkoutSessionId}/update_shipping_option
GET
/purchase_order/{purchaseOrderId}

Fields

Field
Type
Description
discount
Amount
The container that returns the monetary value of the promotional discount.

Note: eBay Bucks are not supported.
discountPercentage
string
The discount percentage for the items in this line item. For example, a seller item discount, such as Buy 1 Get 1, or a coupon. Note: The purchase order methods do not support this field.
message
string
The text for the promotion title, which describes the promotion. For example, Buy 1 Get 1.
promotionCode
string
An identifier of the promotion, which was generated by the system when the promotion was created.

Note: No data is returned in this field for the getPurchaseOrder method.
promotionType
string
Indicates the kind of promotion. Some examples are: SellerDiscountedPromotionalOffer and COUPON.