Orders

Update Orders

patch/v1/Orders({ID})

Request

  • Base URL: https://api.channeladvisor.com
  • URL: https://api.channeladvisor.com/v1/Orders({ID})
  • Auth: OAuth 2 (authorization code, authorization URL https://api.channeladvisor.com/oauth2/authorize, token URL https://api.channeladvisor.com/oauth2/token; implicit, authorization URL https://api.channeladvisor.com/oauth2/authorize, scopes: orders, inventory) and HTTP bearer

Path parameters

IDnumber required

The unique identifier of Order

Request body

SellerOrderIDstring nullable
CheckoutSourceIDnumber nullable
PublicNotesstring nullable
PrivateNotesstring nullable
SpecialInstructionsstring nullable
EstimatedShipDateUtcstring date-time nullable
DeliverByDateUtcstring date-time nullable
FlagIDnumber nullable
FlagDescriptionstring nullable
CheckoutStatus'NotVisited' | 'Completed' | 'Visited' | 'CompletedAndVisited' | 'Disabled' | 'CompletedOffline' | 'OnHold'
PaymentStatus'NotYetSubmitted' | 'Cleared' | 'Submitted' | 'Failed' | 'Deposited'
ShippingStatus'Unshipped' | 'Shipped' | 'PartiallyShipped' | 'PendingShipment' | 'Canceled' | 'ThirdPartyManaged'

Indicates the shipping state of an order.

ValueDescription
UnshippedFulfillment is incomplete. This is the default value.
ShippedFulfillment is complete.
PartiallyShippedFulfillment is incomplete.
PendingShipmentFulfillment is incomplete.
CanceledFulfillment is complete.
ThirdPartyManagedFulfillment is complete.
CheckoutDateUtcstring date-time nullable
PaymentDateUtcstring date-time nullable
ShippingTitlestring nullable
ShippingFirstNamestring nullable
ShippingLastNamestring nullable
ShippingSuffixstring nullable
ShippingCompanyNamestring nullable
ShippingCompanyJobTitlestring nullable
ShippingDaytimePhonestring nullable
ShippingEveningPhonestring nullable
ShippingAddressLine1string nullable
ShippingAddressLine2string nullable
ShippingCitystring nullable
ShippingPostalCodestring nullable
ShippingCountrystring nullable
ShippingAddressType'Undefined' | 'Residential' | 'Commercial'

Example request

{
  "SellerOrderID": "string",
  "CheckoutSourceID": 0,
  "PublicNotes": "string",
  "PrivateNotes": "string",
  "SpecialInstructions": "string",
  "EstimatedShipDateUtc": "0001-01-01T00:00:00+00:00",
  "DeliverByDateUtc": "0001-01-01T00:00:00+00:00",
  "FlagID": 0,
  "FlagDescription": "string",
  "CheckoutStatus": "NotVisited",
  "PaymentStatus": "NotYetSubmitted",
  "ShippingStatus": "Unshipped",
  "CheckoutDateUtc": "0001-01-01T00:00:00+00:00",
  "PaymentDateUtc": "0001-01-01T00:00:00+00:00",
  "ShippingTitle": "string",
  "ShippingFirstName": "string",
  "ShippingLastName": "string",
  "ShippingSuffix": "string",
  "ShippingCompanyName": "string",
  "ShippingCompanyJobTitle": "string",
  "ShippingDaytimePhone": "string",
  "ShippingEveningPhone": "string",
  "ShippingAddressLine1": "string",
  "ShippingAddressLine2": "string",
  "ShippingCity": "string",
  "ShippingPostalCode": "string",
  "ShippingCountry": "string",
  "ShippingAddressType": "Undefined"
}

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.