Step 2. Update RmaNumber, SellerAdjustmentID, or PublicNotes


When to Use

  • When a new request for an RMA has been received, this request provides the option to set the RMA Number, Seller Adjustment ID, and Public Notes (on the adjustment) based on specific business needs before moving the Buyer Initiated Return forward in the process.
    • Note: there are different URLs are defined below for Order-Level vs Item-Level, but the body is the same.
  • This request will set the RMA Number, Seller Adjustment ID, and Public Notes - all properties are optional. Send based on business need.

Resource URL / Endpoint

Order Level: PATCH or PUT https://api.channeladvisor.com/v1/OrderAdjustments(OrderAdjustmentID)
Item Level:
PATCH or PUT https://api.channeladvisor.com/v1/OrderItemAdjustments(OrderItemAdjustmentID)

Important and/or Required Parameters

PropertyType (Max Length)RequiredNote
OrderAdjustmentIDinteger (32 bit)ConditionalRequired for Order-Level RMA request only. Include in URL.
ChannelAdvisor system generated unique ID for the Order-Level RMA/adjustment within this order.
OrderItemAdjustmentIDinteger (32 bit)ConditionalRequired for Item-Level RMA request only. Include in URL.
ChannelAdvisor system generated unique ID for the Item-Level RMA/adjustment item within this order.
RmaNumberstring (50)OptionalOnly required if the goal is to send an RmaNumber. Include in Body.
RMA Number for Buyer Initiated Returns.
SellerAdjustmentIDstring (50)OptionalOnly required if the goal is to send an RmaNumber. Include in Body.
Identifier provided by the seller. 
PublicNotesstring (4,000)OptionalOptional in all scenarios. Include in Body.
Value will appear in ChannelAdvisor Order UI in the "Order History" section, under the "Details" column.
Item Level Example Request
PATCH or PUT https://api.channeladvisor.com/v1/OrderItemAdjustments(778889999100)?access_token=xxxxxxxxxx
{
	"SellerAdjustmentID": "64453-Mens_R.Brown-8.5M",
	"RmaNumber": "4839383894810",
	"PublicNotes": "Seller returning due to incorrect sized shoe in box."
}
Item Level Example Response (Success)
204 No Content