Add SellerOrderID, Update Private Notes, and Update Shipping Status on an Existing Order


Resource URL / Endpoint

PATCH or PUT https://api.channeladvisor.com/v1/Orders(OrderID)

Important and/or Required Parameters

PropertyRequiredNote
OrderIDRequiredInclude in URL. The ChannelAdvisor generated unique identifier for the Order.
SellerOrderIDRequiredInclude in body. Required to fulfill goal.
PrivateNotesRequiredInclude in body. Required to fulfill goal.
ShippingStatusRequired

Include in body. Required to fulfill goal. "PendingShipment" is only valid value seller can change the value to.
Other ShippingStatus values are set when order fulfillments are updated and items are shipped. ChannelAdvisor's system sets those values. 

Example Request
PATCH or PUT https://api.channeladvisor.com/v1/Orders(12345678)?access_token=xxxxxxxxxx
{
    "SellerOrderID": "1ei9_0009983747",
	"PrivateNotes": "Buyer contacted Customer Support and requested extra padding on the shipment; received by HM (EID 88732)",
	"ShippingStatus": "PendingShipment"
}
Example Response (Success)
204 No Response

Expected Behavior

  • The SellerOrderID field will be updated on the order to match what was provided in the POST request.
  • The PrivateNotes field will be updated on the order to match the value provided.
  • ShippingStatus is updated to PendingShipment.