Change to an order item summary, such as a return or cancel. You specify whether to
prorate the associated shipping charge based on the price change. The order item summary can’t
be a shipping charge.
| Property | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| changeItemFees | List<ChangeItemFee> | List of input data for fees associated with the order item being returned or canceled. | Optional | 57.0 |
| orderItemSummaryId | String | ID of the order item summary. | Required | 48.0 |
| quantity | Double | Quantity to change. Use a positive value. For example, a value of 2 means “cancel or return 2 units.” | Required | 48.0 |
| reason | String | Reason for the change. The value must match one of the picklist values on the Reason field of the OrderItemSummaryChange object. | Required | 48.0 |
| reasonForChangeText | String | Reason text used for the return insights. The value has a max of 255 characters. | Optional | 59.0 |
| shippingReductionFlag | Boolean | Specifies whether to prorate the shipping charge. | Required | 48.0 |