Full Item Refund (Buyer Return) - Retain Fee for Restocking

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 Goals

  • Note: this scenario is different than a pre-shipment retention of shipping costs because all items have been marked as shipped on the order, therefore the action is considered a partial price refund (not cancellation), which most marketplaces allow.
  • Marketplace allows item-level refunds/cancellations.
  • Refund all cost associated with the order minus 6.73 (15% of item total) as an restocking fee.
  • Send valid reason for refund (recommended)
  • Send an adjustment ID
  • Don't restock product immediately as stock levels are high

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.
ReasonRequiredInclude in body. Required to fulfill goal. Indicates why the adjustment was requested. Use enum values.
Defaults to "GeneralAdjustment" if property is not provided.
ItemAdjustmentRequiredInclude in body. Required to fulfill goal. The amount returned from item costs minus restocking fee.
TaxAdjustmentRequiredInclude in body. Required to fulfill goal. The amount returned from item tax costs.
ShippingAdjustmentRequiredInclude in body. Required to fulfill goal. The amount returned from shipping costs.
ShippingTaxAdjustmentRequiredInclude in body. Required to fulfill goal. The amount returned from shipping tax 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 & Response
POST https://api.channeladvisor.com/v1/OrderItems(12345678)/Adjust?access_token=xxxxxxxxxx
    "Reason": "CustomerReturnedItem",
    "SellerAdjustmentID": "SampleAdjustmentID-12345",
    "ItemAdjustment": 38.12,
    "TaxAdjustment": 3.59,
    "ShippingAdjustment": 9.95,
Example Response (Success)
204 No Response

Expected Behavior

  • Every dollar defined in the request will be refunded, including the 38.12 (6.73 less than the original total). This will be communicated back to the marketplace as a refund, and the marketplace will refund it through whatever payment method was originally used (ie: PayPal, Amazon, etc).
    • Even if a restocking fee is clearly marked in a listing and emails sent to the buyers to be sure they are aware of it, marketplaces may penalize seller ratings for implementing restocking fees, as it creates a negative buyer experience.
  • A valid marketplace reason will be converted from the "CustomerReturnedItem" 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 defaults to 'false' and Quantity will not be added back to the ChannelAdvisor system.