Updating Existing Order Properties


When to Use & Other Considerations

  • To apply a unique seller order id for internal tracking purposes.
    • These values are often NOT shared with marketplaces because most marketplaces do not have a place for this data.
    • Amazon does accept a SellerOrderID.
  • To add other notes the order that will (or will not) be shared with the seller via the marketplace.
    • This applies to the PublicNotes and PrivateNotes fields.
  • To flag orders for internal tracking purposes by using the FlagID and FlagDescription properties.
  • To update the shipping name/address on an order.
    • Updates to name and addresses on the order are not shared with the marketplaces.
  • Manually managing orders in the system (e.g. use ChannelAdvisor as the system of record for an order from another system that ChannelAdvisor does not support directly), and need to update things like payment information, or a variety of other fields and statuses on the order.
  • Note: item level data on an order cannot be updated though these requests. To refund or cancel items or part of an item in an order, do so using the PATCH or PUT /v1/Orders(id) endpoint.

Update Order Properties Endpoint

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

Important and/or Required Parameters (for Order Level Properties)

Property Type (Max Length) Required Description
ID integer (32 bit) Required Include in URL. The ChannelAdvisor generated unique identifier for the Order.
SellerOrderID string (25) Optional Identifier provided by the seller.
PublicNotes string (4,000) Optional Notes from the seller which may be included in a printed invoice or packing slip.
PrivateNotes string (4,000) Optional Notes from the seller which cannot be included in a printed invoice or packing slip.
SpecialInstructions string (255) Optional Notes provided by the buyer, usually pertaining to shipping instructions.
EstimatedShipDateUtc DateTimeOffset Optional Timestamp estimating when the order will be fulfilled.
DeliverByDateUtc DateTimeOffset Optional Timestamp indicating the deadline for fulfilling the order.
FlagID enum Optional Identifies the flag type, if any.
FlagDescription string (80) Optional Describes the flag.
CheckoutStatus enum Optional Indicates the progress of the order through the checkout process.
PaymentStatus enum Optional Indicates the progress of the payment.
ShippingStatus enum Optional, PendingShipment only Indicates the progress of the fulfillment on the order. This value can only be set to 'PendingShipment'. Other values are set by ChannelAdvisor when marking shipping updates on items in the order.
CheckoutDateUtc DateTimeOffset Optional Timestamp indicating the latest update to CheckoutStatus.
PaymentDateUtc DateTimeOffset Optional Timestamp indicating the latest update to PaymentStatus.
PaymentMethod string (50) Optional The type of payment submitted by the buyer.
PaymentTransactionID string (255) Optional The TransactionID of the payment.
PaymentCreditCardLast4 string (4) Optional The last four digits of the credit card number.
PaymentMerchantReferenceNumber string (50) Optional The reference number of the payment.
ShippingTitle string (20) Optional The shipping recipient's title.
ShippingFirstName string (50) Optional The shipping recipient's first name.
ShippingLastName string (50) Optional The shipping recipient's last name.
ShippingSuffix string (20) Optional The shipping recipient's name suffix.
ShippingCompanyName string (50) Optional The shipping recipient's company name.
ShippingCompanyJobTitle string (50) Optional The shipping recipient's job title.
ShippingDaytimePhone string (40) Optional The shipping recipient's daytime phone number.
ShippingEveningPhone string (40) Optional The shipping recipient's evening phone number.
ShippingAddressLine1 string (100) Optional The first line of the shipping address.
ShippingAddressLine2 string (100) Optional The second line of the shipping address.
ShippingCity string (100) Optional The city of the shipping address.
ShippingStateOrProvince string (15) Optional The region of the shipping address.
ShippingPostalCode string (15) Optional The postal code of the shipping address.
ShippingCountry string (10) Optional The country of the shipping address.
BillingTitle string (20) Optional The payer's title.
BillingFirstName string (50) Optional The payer's first name.
BillingLastName string (50) Optional The payer's last name.
BillingSuffix string (20) Optional The payer's name suffix.
BillingCompanyName string (50) Optional The payer's company name.
BillingCompanyJobTitle string (50) Optional The payer's job title.
BillingDaytimePhone string (40) Optional The payer's daytime phone.
BillingEveningPhone string (40) Optional The payer's evening phone.
BillingAddressLine1 string (100) Optional The first line of the billing address.
BillingAddressLine2 string (100) Optional The second line of the billing address.
BillingCity string (100) Optional The city of the billing address.
BillingStateOrProvince string (15) Optional The region of the billing address.
BillingPostalCode string (15) Optional The postal code of the billing address.
BillingCountry string (10) Optional The country of the billing address.

Update OrderItem Properties Endpoint

PATCH or PUT https://api.channeladvisor.com/v1/OrderItems(OrderItemID)

Important and/or Required Parameters (for Item Level Properties)

Property Type (Max Length) Required Description
ID integer (32 bit) Required Include in URL. The ChannelAdvisor generated unique identifier for the Item.
SellerOrderItemID string (25) Optional Identifier provided by the seller.

Order Property Update Request Examples