Creates a one-time discount and attaches it to a specific item, order, or shipping rate for an individual customer.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Response Body Definitions
| Name | Type | Description | Example |
|---|---|---|---|
| public_id | string | One-Time Incentive ID | 8637c3fe9b7011eaa2c1bc764e107990 |
| external_code | string | External Code | awesome_discount |
| description | string | Description | One-Time Incentive |
| merchant | string | Merchant ID | ac4f7938383a11e89ecbbc764e1107f2 |
| customer | string | Customer ID | 00026001 |
| order | string | Order ID | c4e05d04ccc411e8ada3bc764e101db1 |
| created | string | Datetime of creation | 2020-05-21 09:36:57 |
| last_updated | string | Datetime of last update | 2020-05-21 09:36:57 |
| incentive | object | Incentive object |
Body Parameters
Targeting
Use either the order or item body parameter and different incentive.target values based on the scope of the discount you want to provide.
Item-Level Discount for an Individual Item
Use "item": <Item Public ID> body parameter to provide the item public ID
Use "target": “item” within the incentive parameter
Item-Level Discount for All Items in the Order
Use "order": <Order Public ID> body parameter to provide the order public ID
Use “target”: “item” within the incentive parameter
Order-level discount
Use "order": <Order Public ID>” body parameter to provide the order public ID
Use “target”: “order” within the incentive parameter
Shipping-Level Discount
Use "order": <Order Public ID>” body parameter to provide the order public ID
Use “target”: “shipping_total” within the incentive parameter
Notes for gift type incentives: The support for gift incentives in one-time incentives are only limited to item-level scope so, be sure to use "item": <Item Public ID> in the body parameter and "target": “item”inside the incentive parameter
Discount Limits
A "discount limit" can be specified using the limit_value and limit_policy parameters.
Limit Policy
The fixed policy indicates that the limit_value parameter value should be interpreted as a hard-coded dollar value limit for the discount. This limit will apply to the specified incentive.target. For example, if incentive.target=item, then the limit will apply to each individual item - meaning the total discount applied could be greater than the limit value, but the individual discount for each item will not be greater than the limit.
Limit Value
The limit_value must be an integer, the exact meaning of the provided input will be determined based on the specified limit_policy.
For an explanation of the business logic, visit Advanced One-Time Discounts in Knowledge Center.