DiscountAllocationDetailsInput
Version 2024-01-01
Important
The Buy with Prime API is offered as a preview and might change as we receive feedback and iterate on the interfaces. We are sharing this early documentation to help you learn about the Buy with Prime API as we write and iterate on the content.
Overview
Details for the discount allocated to an entity.
With DiscountAllocationInput we can support the following use cases:
- associate the discount details like discount amount and couponCodes(if any) with the line item in the shopper's order confirmation page.
- associate the discount details like discount amount and couponCodes(if any) with the line item in the merchant's order management page.
- give refund estimate in case specific LineItems are returned.
Arguments
| Argument | Description |
|---|---|
aliases ([AliasInput]) | Unique identifiers of promotion entities such as external promotion id. |
amount (MoneyInput required) | The discount amount. |
couponCode (String) | The coupon code used to redeem the promotion. The size should be greater than or equal to 0 and less than or equal to 50. |
displayString (String) | The message for display which indicates why this promotion was applied to the corresponding entity. |
promotionAliases ([AliasInput]) | DeprecatedUse Unique identifiers of promotion entities such as external promotion id. |
Updated 2 days ago