PriceAdjustment document (Shop API 17.7)

(supports custom properties)

Document representing a price adjustment within a basket or order. Price adjustments can be assigned at the order, product, or shipping level. They can be created by the promotion engine (if the custom flag is set to false) or can be added by custom logic (if the custom flag is set to true). For custom price adjustments created by a user, the manual flag should be set to true; this is always the case for price adjustments created using OCAPI. A price adjustment created by custom logic can either define a price that defines the absolute price reduction or define a discount from which a price reduction is calculated (amount, percentage, and fixed_price discounts are supported). The applied_discount property describes the discount applied to create the price-adjustment.

Property	Type	Description
`applied_discount`	Discount	A price adjustment that provides details of the discount that was applied. This is `null` for custom price adjustments created without discount details.
`coupon_code`	String	The coupon code that triggered the promotion, provided the price adjustment was created as the result of a promotion being triggered by a coupon.
`created_by`	String	The user who created the price adjustment.
`creation_date`	Date	Returns the value of attribute 'creationDate'.
`custom`	Boolean	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.
`item_text`	String	The text describing the item in more detail.
`last_modified`	Date	Returns the value of attribute 'lastModified'.
`manual`	Boolean	A flag indicating whether this price adjustment was created in a manual process. For custom price adjustments created using the shop API, this always returns `true`. Using the scripting API, however, it is possible to set this to `true` or `false`, according to the use case.
`price`	Decimal	The adjustment price.
`price_adjustment_id`	String	The price adjustment id (uuid).
`promotion_id`	String	The id of the related promotion. Custom price adjustments can be assigned any promotion id so long it is not used by a price adjustment belonging to the same item and is not used by promotion defined in the promotion engine. If not specified, a promotion id is generated.
`promotion_link`	String	The URL addressing the related promotion.
`reason_code`	String	The reason why this price adjustment was made.

X OCAPI versions 15.x and 16.x will be retired on March 31, 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.