Connect REST API Developer Guide
jOrder Summaries, Preview Adjust
Retrieve the expected results of adjusting the price of one or more
OrderItemSummaries from an OrderSummary, without actually executing the adjustment. The
response data contains the financial changes that would result from submitting the proposed
adjustment.
- Resource
-
1/commerce/order-management/order-summaries/orderSummaryId/actions/adjust-item-preview - Available version
- 49.0
- HTTP methods
- POST
- Request body for POST
-
Adjust Order Item Summary Input
- Root XML tag
- <adjustOrderItemSummaryInput>
- JSON example
-
1{ 2 "adjustItems": [{ 3 "reason": "Unknown", 4 "amount": -45, 5 "adjustmentType": "AmountWithoutTax", 6 "orderItemSummaryId": "10uxx0000004EXLAA2", 7 "description": "foobar" 8 }], 9 "allocatedItemsChangeOrderType": "Disallowed" 10} - Properties
-
Name Type Description Required or Optional Available Version adjustItems Adjust Item Input[] List of price adjustments to order item summaries. Required 49.0 allocatedItemsChangeOrderType String Process to use for order item summary quantities that are currently being fulfilled, defined as QuantityAllocated - QuantityFulfilled. Values are: - Disallowed—When distributing the adjustment, ignore any quantities being fulfilled. If an order item summary’s entire quantity is being fulfilled, return an error. This is the default value.
- InFulfillment—When distributing the adjustment, include quantities being fulfilled. Create a separate change order for the adjustments made to those quantities.
- PreFulfillment—When distributing the adjustment, include quantities being fulfilled. Include the adjustments made to those quantities in the change order for pre-fulfillment quantity adjustments.
Optional 55.0 individualLineItemTaxAdjustments Boolean Specifies whether to create multiple lines for each tax adjustment or one line with all tax adjustments. The default value is false. Optional 59.0
- Response body for POST
-
- When the HTTP status code indicates success, the response body is an Adjust Order Summary Output. The response body can still indicate processing errors.
- When the HTTP status code is in the 400 (client error) or 500 (server error) range, the response body is an Error with Output. The output property is an Adjust Order Summary Output, and the value of the enhancedErrorType property can be ignored.