Add FlagID and FlagDescription 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.
FlagIDRequiredInclude in body. Required to fulfill goal. Must be one of the enum values.
FlagDescriptionRequiredInclude in body. Required to fulfill goal.
Example Request
PATCH or PUT https://api.channeladvisor.com/v1/Orders(12345678)?access_token=xxxxxxxxxx
{
    "FlagID": "2",
	"FlagDescription": "Pending Confirmation from Distributor on Backorder Date"
}
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.