Partial Item Refund of Shipping Charges Only


Order Scenario for Examples

Order TypeSingle SKU, Multi Quantity
Total Quantity3
Item Unit Price14.95
Total Item Price (Qty x Unit Price)44.85
Total Order Tax3.59
Total Order Shipping9.95
Total Order Shipping Tax0.15

Scenario Specific Goal

  • Refund only the shipping costs associated with an item as a courtesy to the buyer for very late arrival of shipment.
  • Send adjustment ID.

Resource URL / Endpoint

POST https://api.channeladvisor.com/v1/OrderItems(OrderItemID)/Adjust

Important and/or Required Parameters

PropertyRequiredDescription
OrderItemID RequiredInclude in URL. The ChannelAdvisor generated unique identifier for the OrderItem.
ItemAdjustmentRequiredInclude in body. Required to fulfill goal. Send a value of zero. If property is omitted, the request will fail.
ShippingAdjustmentRequiredInclude in body. Required to fulfill goal. The amount returned from shipping costs.
SellerAdjustmentIDRequiredInclude in body. Required to fulfill goal. Identifier provided by the seller.
All other OrderItem Adjustment properties are optional. See full list of available properties at Refund & Cancel Orders (Item Level).
Example Request
POST https://api.channeladvisor.com/v1/OrderItems(12345678)/Adjust?access_token=xxxxxxxxxx
{
    "SellerAdjustmentID": "SampleAdjustmentID-12345",
    "ItemAdjustment": 0,
    "ShippingAdjustment": 9.95
}
Example Response (Success)
204 No Response

Expected Behavior

  • The total ShippingAdjustment price (9.95) sent in the request is refunded. This will be communicated back to the marketplace as a refund, and the marketplace will refund the total amount through whatever payment method was originally used (ie: PayPal, Amazon, etc).
  • A valid marketplace reason will be converted from the "GeneralAdjustment" default value (since it was omitted from the request), and will be sent to the marketplace.
  • The SellerAdjustmentID value will be set to "SampleAdjustmentID-12345" in the ChannelAdvisor system, but will not be shared with the marketplace.
  • Restock defaults to 'false' and quantity will not be added back to the ChannelAdvisor system.