commerce/orders/orderadjustment

Use this subresource to manage ad-hoc order level price adjustments.

JSON Example

Adjustment Properties

Property Description
amount

type: decimal

The amount of the order-level adjustment, which can be a positive or negative amount.

description

type: string

The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types.

internalComment

type: string

Administrator notes associated with the order adjustment. These comments are not shopper facing.

Operations

Operation Name Request URI Description
ApplyAdjustment PUT %7borderId%7d%2fadjustment%3fupdatemode%3d%7bupdateMode%7d%26version%3d%7bversion%7d%26responseFields%3d%7bresponseFields%7d

Applies a price adjustment to the specified order.

ApplyHandlingAdjustment PUT %7borderId%7d%2fadjustment%2fhandling%3fupdatemode%3d%7bupdateMode%7d%26version%3d%7bversion%7d%26responseFields%3d%7bresponseFields%7d

Updates the order handling adjustment.

ApplyShippingAdjustment PUT %7borderId%7d%2fadjustment%2fshipping%3fupdatemode%3d%7bupdateMode%7d%26version%3d%7bversion%7d%26responseFields%3d%7bresponseFields%7d

Applies a shipping adjustment to the specified order.

RemoveAdjustment DELETE %7borderId%7d%2fadjustment%3fupdatemode%3d%7bupdateMode%7d%26version%3d%7bversion%7d

Removes a price adjustment from the specified order.

RemoveHandlingAdjustment DELETE %7borderId%7d%2fadjustment%2fhandling%3fupdatemode%3d%7bupdateMode%7d%26version%3d%7bversion%7d

Removes an adjustment to the order handling fee.

RemoveShippingAdjustment DELETE %7borderId%7d%2fadjustment%2fshipping%3fupdatemode%3d%7bupdateMode%7d%26version%3d%7bversion%7d

Removes a shipping adjustment previously applied to an order or draft.