Discount Object Fields
You can specify discounts at the transaction or transaction-line level.
Detailed information about discounts is provided in the Configuring Discounts topic.
The following table lists the fields that you can use to specify a discount in your requests. You only need to use one of the discount.discount_amount or discount.discount_total_amount fields, matching the logic you use for amounts generally, that is whether you use tax inclusive or tax exclusive prices. The API will calculate the amounts for both options and return these in the response.
| Field | Details | Description |
|---|---|---|
discount_code | Type: String | Discount code. Used to track the relationship of transaction-level discountsand discounts to individual transaction lines. |
discount_description | Type: String Max: 256 | Description of the discount. |
discount_amount | Type: Number | The amount of the discount that is applied for tax exclusive prices. If your prices do not include tax, use this field. |
discount_total_amount | Type: Number | The amount of the discount that is applied for tax inclusive prices. If your prices do include tax, use this field. |
seller_code | Type: String | The code of the seller who issued the discount. |
Updated 23 days ago