Full Item Cancel on Unshipped Product

Order Scenario for Example

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 Goals

  • The marketplace allows for item-level cancellations
  • Need to send valid reason for cancellation
  • Send an adjustment ID
  • Restock product immediately

Resource URL / Endpoint

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

Important and/or Required Parameters

OrderItemID RequiredInclude in URL. The ChannelAdvisor generated unique identifier for the OrderItem.
RestockRequiredInclude in body. Required to fulfill goal. Indicates the adjusted quantity should be added back to available quantity.
Defaults to 'false' if property is not provided.
ReasonRequiredInclude in body. Required to fulfill goal. Indicates why the adjustment was requested. Use enum values.
Defaults to "GeneralAdjustment" if property is not provided.
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 & Response
POST https://api.channeladvisor.com/v1/OrderItems(12345678)/Adjust?access_token=xxxxxxxxxx
    "Reason": "BuyerCancelled",
    "SellerAdjustmentID": "SampleAdjustmentID-12345",
    "Restock": true
Example Response (Success)
204 No Response

Expected Behavior

  • All items and costs - including (unit price x total quantity), item tax, shipping costs, shipping tax, gift wrap costs, gift wrap tax, and recycling fees - originally on the order will be communicated back to the marketplace as a refund. 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 "BuyerCancelled" value provided, 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 is defined as 'true' and Quantity of 3 will be added back to the ChannelAdvisor system.