Connect REST API Developer Guide
jNewer Version Available
Order Summaries, Submit Adjust
Adjust the price of one or more OrderItemSummaries from an
OrderSummary, and create one or two corresponding change orders.
- Resource
-
1/commerce/order-management/order-summaries/orderSummaryId/actions/adjust-item-submit - Available version
- 49.0
- Requires Chatter
- No
- 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 "appeasementType": "AmountWithoutTax", 6 "orderItemSummaryId": "10uxx0000004EXLAA2", 7 "description": "foobar" 8 }] 9} - Properties
-
Name Type Description Required or Optional Available Version adjustItems Adjust Item Input[] List of price adjustments to OrderItemSummaries. Required 49.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.
- Usage
- After submitting a price adjustment, process refunds as appropriate:
- If the discount only applied to OrderItemSummaries for which payment has not been captured, it does not require a refund. This situation normally applies to OrderItemSummaries in the US that have not been fulfilled.
- If the discount applied to OrderItemSummaries that have not been fulfilled and for which payment has been captured, process a refund. In this case, pass the totalExcessFundsAmount from the response body to the Order Summaries, Ensure Refunds Async resource.
- If the discount applied to OrderItemSummaries that have been fulfilled, process a refund. Pass the postFulfillmentChangeOrderId from the response body to the Order Summaries, Create Credit Memo resource, then pass the CreditMemo to the Order Summaries, Ensure Refunds Async resource.
- If the discount applied to both fulfilled and unfulfilled OrderItemSummaries for which payment has been captured, process both refunds. Pass the postFulfillmentChangeOrderId from the response body to the Order Summaries, Create Credit Memo resource, then pass the credit memo and the totalExcessFundsAmount from the response body to the Order Summaries, Ensure Refunds Async resource.