Document representing a price adjustment within a basket or order. Price adjustments can be assigned at the order, product, or shipping level.
This type supports additional properties passed along with the defined properties of this API. To indicate that the properties were defined and expected to be handled as additional properties, they are expected to be prefixed with a c_
. The type will reject any property that does not fit this pattern, only allowing additional properties beginning with the known prefix.
c_faxNumber
The adjustment amount, including tax.
50.00
The amount used to calculate the tax for this adjustment.
50.00
Details describing the discount this price adjustment is based on. For adjustments not based on a discount, this value is null.
The adjustment amount. If the taxation policy is net, it doesn't include tax. If the taxation policy is gross, it includes tax.
12.00
The campaign ID of the promotion this price adjustment is based on. For adjustments not based on a promotion, this value is null. For adjustments based on an AB test promotion, this value is not null, but isn't meaningful.
FreeShipping24
The timestamp when the price adjustment was last modified.
2021-02-25T09:58:08.715Z
The promotion ID of the promotion this price adjustment is based on. Custom price adjustment can assign an arbitrary promotion ID, but it must be not used by the promotion engine. If no promotion ID is specified, then the system assigns a generated ID.
FreeShipping24
The user who created the price adjustment.
Customer
A flag indicating whether this price adjustment was created by custom logic. This flag is set to true unless the price adjustment was created by the promotion engine.
false
The text describing the adjustment.
Employee discount applied.
A flag indicating whether this price adjustment was created by a manual process. If the price adjustment was created by the promotion engine, this value is always false.
false
The price adjustment ID.
ba248424e3eee797f062161f8b
The AB testing segment, if enabled for the site and applicable to this price adjustment.
The coupon code of the coupon this price adjustment is based on. For adjustments not based on a coupon, this value is null.
5ties
The tax on the adjustment amount.
0.19
The timestamp when the price adjustment was created.
2021-02-25T09:58:04.691Z
The adjustment amount, not including tax.
38.00
The reason code why this price adjustment was made.
Employee discount was applied