Full Item Refund on Shipped Items


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

  • Send valid reason for refund (recommended)
  • Send an adjustment ID
  • Restock product immediately

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.
QuantityOptional

Optional to include.
The number of units being adjusted. Cannot be more than the total in the original order.
If excluded, ChannelAdvisor will assume all Quantity is being refunded in a request.

RestockOptionalOnly required to fulfill scenario goal. Indicates the adjusted quantity should be added back to available quantity.
Defaults to 'false' if property is not provided.
ReasonOptionalOnly required to fulfill scenario goal. Indicates why the adjustment was requested. Use enum values.
Defaults to "GeneralAdjustment" if property is not provided.
ItemAdjustmentOptionalOptional to include - only required if goal is to refund total amount AND want define the dollar amount to refund.
The amount returned from Item costs.
TaxAdjustmentOptionalOptional to include - only required if Tax Price was populated on original order item and goal is to refund total amount.
The amount returned from item Tax costs.
ShippingAdjustmentOptionalOptional to include - only required if Shipping Price was populated on original order item and goal is to refund total amount.
The amount returned from Shipping costs.
ShippingTaxAdjustmentOptionalOptional to include - only required if Shipping Tax Price was populated on original order item and goal is to refund total amount.
The amount returned from Shipping Tax costs.
SellerAdjustmentIDOptionalOnly required to fulfill scenario goal. Identifier provided by the seller.
Example Request & Response #1
POST https://api.channeladvisor.com/v1/OrderItems(12345678)/Adjust?access_token=xxxxxxxxxx
{
    "Reason": "CustomerReturnedItem",
    "SellerAdjustmentID": "SampleAdjustmentID-12345",
    "Restock": true,
    "Quantity": 3,
    "ItemAdjustment": 44.85,
    "TaxAdjustment": 3.59,
    "ShippingAdjustment": 9.95,
    "ShippingTaxAdjustment": 0.15
}

Expected Behavior

Note: generally this format is not advised, as it creates more data to send unnecessarily. We recommend only sending properties that are relevant to the refund to keep requests smaller.

  • All items and costs directly defined in the request (in ItemAdjustment, TaxAdjustment, ShippingAdjustment, ShippingTaxAdjustment) properties will be communicated back to the marketplace as a refund if they are less than or equal to the the individual property totals. The marketplace will refund these amounts through whatever payment method was originally used (ie: PayPal, Amazon, etc).
  • 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 is defined as 'true' and Quantity of 3 will be added back to the ChannelAdvisor system.

The following request will return the same result as Request #1 - ChannelAdvisor will assume Quantity=3 is being refunded, and will pull the original Item, Tax, Shipping, and ShippingTax prices from the system for the refund request.

Example Request & Response #2
POST https://api.channeladvisor.com/v1/OrderItems(12345678)/Adjust?access_token=xxxxxxxxxx
{
    "Reason": "CustomerReturnedItem",
    "SellerAdjustmentID": "SampleAdjustmentID-12345",
    "Restock": true
}

In this request, the scenario goals are not met because the Reason will default to "GeneralAdjustment", Restock will default to "false", and no SellerAdjustmentID will be sent. But the full amount of the item will still be refunded. No body is required.

Example Request & Response #2
POST https://api.channeladvisor.com/v1/OrderItems(12345678)/Adjust?access_token=xxxxxxxxxx
Example Response for All Requests Above (Success)
204 No Response