Refund & Cancel Orders (Order Level)


When to Use & Other Considerations

  • Buyer wants to cancel the entire order and seller will refund the full order.
  • Seller wants to refund the full original amount of the order for any reason.
  • Seller wants to cancel the full original amount of the order for any reason.
  • Seller wants to refund part of the order price, but specifying the amount at the item level is not appropriate AND the marketplace allows for order level partial price refunds.
  • For US and Canadian eBay Sellers:
    • If an eBay account is enabled for Premium Tax, submit cancel/refund adjustments are required at the item level.
    • If an eBay account is NOT enabled for Premium Tax, submit cancel/refund adjustments are required at the order level.
  • For non-US eBay Sellers: submit cancel/refund adjustments at the item level.
  • Partial quantity refund/cancel = refunding part of the quantity of an order, but a full amount of the unit cost x quantity + appropriate tax, shipping, and shipping tax (each x quantity).
    • Some marketplaces will allow a partial quantity Item Level refund/cancel (but not Order Level, as quantity is not defined at the order level).
    • Note: any attempt to refund anything less than the order total (for Order Level requests) or item total (for Item Level requests), is considered a partial price refund/cancel.
    • Order Level Behavior for Partial Quantity Cancellations: cannot send a request for partial quantity cancellation where "Quantity" property is defined, as "Quantity" exists at the item level.
    • Order Level Behavior for Partial Quantity Refunds: cannot send a request for partial quantity cancellation where "Quantity" property is defined, as "Quantity" exists at the item level.
  • Partial price refund/cancel = refunding part of the price of an order, but not the full amount of the unit or order (ie: withholding shipping costs)
    • Only Wish and eBay allow for Order Level or Item Level partial price cancellations.
      • For example: buyer cancels 1 out of 4 items purchased - as a seller, you want to retain the shipping costs on the order, so you would issue a partial price cancellation.
    • Order Level Behavior for Partial Price Cancellationsif "AdjustmentAmount" is less than the total original order value in a pre-shipment scenario (cancellation), it will be ignored by ChannelAdvisor and the entire order amount (total order price including taxes, shipping, etc) will be returned to the buyer.
      • For a partial price cancellation example, see Cancel Part of Order and Retain Shipping Costs page.
    • Order Level Behavior for Partial Price Refunds: all items must be shipped (or previously cancelled or refunded), and a Partial Order Refund request needs to be executed. The value passed in the "AdjustmentAmount" field will be honored if the marketplace allows for Order Level Refunds.

Refund & Cancel Endpoint

POST https://api.channeladvisor.com/v1/Orders(OrderID)/Adjust

Important and/or Required Parameters

PropertyType (Max Length)RequiredDescription
OrderID integer (32 bit)RequiredInclude in URL. The ChannelAdvisor generated unique identifier for the Order.
RestockbooleanOptionalInclude in body. Indicates the adjusted quantity should be added back to available quantity.
Defaults to 'false' if property is not provided.
ReasonenumOptionalInclude in body. Indicates why the adjustment was requested.
Defaults to "GeneralAdjustment" if property is not provided.
SellerAdjustmentIDstring (50)OptionalInclude in body. Identifier provided by the seller.
PreventSiteProcessingbooleanOptional

Include in body. Indicates if the adjustment will be sent to the marketplace.
Default value is 'false' when not provided in the request.
When 'true' is sent, information is logged in ChannelAdvisor only and not shared with the marketplace.

AdjustmentAmountdecimalOptionalInclude in body. The amount returned from item costs. Zero or Positive integer.
RefundOnlybooleanOptional

Include in body. Only applies to Wish and eBay orders.
For partial cancellations or refunds.
When true AND AdjustmentAmount is included in the request, that amount will be the only thing refunded.
When false OR (true AND AdjustmentAmount is omitted from the request), calculated balance available will be refunded.

Order Level Refund & Cancel Math Calculations

PropertyRegular Mathematical Calculations
When TaxType = NoTax, Standard, ExclusiveVat

Mathematical Calculations
When TaxType = InclusiveVat
* not a real field; used for explanation purposes only

AdjustmentAmountTotal amount to be returned from all costs.Total amount to be returned from all costs.

Order Level Refund & Cancel Request Examples