Orders

Create Orders

post/v1/Orders

Request

  • Base URL: https://api.channeladvisor.com
  • URL: https://api.channeladvisor.com/v1/Orders
  • 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

Request body

ProfileIDnumber
SiteIDnumber
SiteNamestring nullable
SiteOrderIDstring nullable
SecondarySiteOrderIDstring nullable
SellerOrderIDstring nullable
CheckoutSourceIDnumber nullable
Currencystring nullable
PublicNotesstring nullable
PrivateNotesstring nullable
SpecialInstructionsstring nullable
TotalPricenumber
TotalTaxPricenumber
TotalShippingPricenumber
TotalShippingTaxPricenumber nullable
TotalInsurancePricenumber
TotalGiftOptionPricenumber nullable
TotalGiftOptionTaxPricenumber nullable
AdditionalCostOrDiscountnumber
EstimatedShipDateUtcstring date-time nullable
DeliverByDateUtcstring date-time nullable
RequestedShippingCarrierstring nullable
RequestedShippingClassstring nullable
ResellerIDstring 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
ShippingDateUtcstring date-time nullable
BuyerUserIdstring nullable
BuyerEmailAddressstring nullable
BuyerEmailOptInboolean nullable
OrderTaxType'NoTax' | 'Standard' | 'ExclusiveVat' | 'InclusiveVat'
ShippingTaxType'NoTax' | 'Standard' | 'ExclusiveVat' | 'InclusiveVat'
GiftOptionsTaxType'NoTax' | 'Standard' | 'ExclusiveVat' | 'InclusiveVat'
PaymentMethodstring nullable
PaymentTransactionIDstring nullable
PaymentPaypalAccountIDstring nullable
PaymentCreditCardLast4string nullable
PaymentMerchantReferenceNumberstring nullable
ShippingTitlestring nullable
ShippingFirstNamestring nullable
ShippingLastNamestring nullable
ShippingSuffixstring nullable
ShippingCompanyNamestring nullable
ShippingCompanyJobTitlestring nullable
ShippingDaytimePhonestring nullable
ShippingEveningPhonestring nullable
ShippingAddressLine1string nullable
ShippingAddressLine2string nullable
ShippingCitystring nullable
ShippingStateOrProvincestring nullable
ShippingStateOrProvinceNamestring nullable
ShippingPostalCodestring nullable
ShippingCountrystring nullable
BillingTitlestring nullable
BillingFirstNamestring nullable
BillingLastNamestring nullable
BillingSuffixstring nullable
BillingCompanyNamestring nullable
BillingCompanyJobTitlestring nullable
BillingDaytimePhonestring nullable
BillingEveningPhonestring nullable
BillingAddressLine1string nullable
BillingAddressLine2string nullable
BillingCitystring nullable
BillingStateOrProvincestring nullable
BillingStateOrProvinceNamestring nullable
BillingPostalCodestring nullable
BillingCountrystring nullable
PromotionCodestring nullable
PromotionAmountnumber
ShippingAddressType'Undefined' | 'Residential' | 'Commercial'

Example request

{
  "ProfileID": 0,
  "SiteID": 0,
  "SiteName": "string",
  "SiteOrderID": "string",
  "SecondarySiteOrderID": "string",
  "SellerOrderID": "string",
  "CheckoutSourceID": 0,
  "Currency": "string",
  "PublicNotes": "string",
  "PrivateNotes": "string",
  "SpecialInstructions": "string",
  "TotalPrice": 0,
  "TotalTaxPrice": 0,
  "TotalShippingPrice": 0,
  "TotalShippingTaxPrice": 0,
  "TotalInsurancePrice": 0,
  "TotalGiftOptionPrice": 0,
  "TotalGiftOptionTaxPrice": 0,
  "AdditionalCostOrDiscount": 0,
  "EstimatedShipDateUtc": "0001-01-01T00:00:00+00:00",
  "DeliverByDateUtc": "0001-01-01T00:00:00+00:00",
  "RequestedShippingCarrier": "string",
  "RequestedShippingClass": "string",
  "ResellerID": "string",
  "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",
  "ShippingDateUtc": "0001-01-01T00:00:00+00:00",
  "BuyerUserId": "string",
  "BuyerEmailAddress": "string",
  "BuyerEmailOptIn": true,
  "OrderTaxType": "NoTax",
  "ShippingTaxType": "NoTax",
  "GiftOptionsTaxType": "NoTax",
  "PaymentMethod": "string",
  "PaymentTransactionID": "string",
  "PaymentPaypalAccountID": "string",
  "PaymentCreditCardLast4": "string",
  "PaymentMerchantReferenceNumber": "string",
  "ShippingTitle": "string",
  "ShippingFirstName": "string",
  "ShippingLastName": "string",
  "ShippingSuffix": "string",
  "ShippingCompanyName": "string",
  "ShippingCompanyJobTitle": "string",
  "ShippingDaytimePhone": "string",
  "ShippingEveningPhone": "string",
  "ShippingAddressLine1": "string",
  "ShippingAddressLine2": "string",
  "ShippingCity": "string",
  "ShippingStateOrProvince": "string",
  "ShippingStateOrProvinceName": "string",
  "ShippingPostalCode": "string",
  "ShippingCountry": "string",
  "BillingTitle": "string",
  "BillingFirstName": "string",
  "BillingLastName": "string",
  "BillingSuffix": "string",
  "BillingCompanyName": "string",
  "BillingCompanyJobTitle": "string",
  "BillingDaytimePhone": "string",
  "BillingEveningPhone": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingCity": "string",
  "BillingStateOrProvince": "string",
  "BillingStateOrProvinceName": "string",
  "BillingPostalCode": "string",
  "BillingCountry": "string",
  "PromotionCode": "string",
  "PromotionAmount": 0,
  "ShippingAddressType": "Undefined",
  "Items": [
    {
      "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderItem"
    }
  ]
}

Response

Created entity

IDnumber
ProfileIDnumber
SiteIDnumber
SiteNamestring nullable
UserDataPresentnumber
UserDataRemovalDateUTCstring date-time nullable
SiteAccountIDnumber nullable
SiteOrderIDstring nullable
SecondarySiteOrderIDstring nullable
SellerOrderIDstring nullable
CheckoutSourceIDnumber nullable
Currencystring nullable
CreatedDateUtcstring date-time
ImportDateUtcstring date-time
UpdatedDateUtcstring date-time nullable
PublicNotesstring nullable
PrivateNotesstring nullable
SpecialInstructionsstring nullable
TotalPricenumber
TotalTaxPricenumber
TotalShippingPricenumber
TotalShippingTaxPricenumber nullable
TotalInsurancePricenumber
TotalGiftOptionPricenumber nullable
TotalGiftOptionTaxPricenumber nullable
AdditionalCostOrDiscountnumber
EstimatedShipDateUtcstring date-time nullable
DeliverByDateUtcstring date-time nullable
RequestedShippingCarrierstring nullable
RequestedShippingClassstring nullable
ResellerIDstring nullable
FlagIDnumber nullable
FlagDescriptionstring nullable
OrderTagsstring nullable
DistributionCenterTypeRollup'SellerManaged' | 'ExternallyManaged' | 'Mixed'
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
ShippingDateUtcstring date-time nullable
BuyerUserIdstring nullable
BuyerEmailAddressstring nullable
BuyerEmailOptInboolean nullable
OrderTaxType'NoTax' | 'Standard' | 'ExclusiveVat' | 'InclusiveVat'
ShippingTaxType'NoTax' | 'Standard' | 'ExclusiveVat' | 'InclusiveVat'
GiftOptionsTaxType'NoTax' | 'Standard' | 'ExclusiveVat' | 'InclusiveVat'
PaymentMethodstring nullable
PaymentTransactionIDstring nullable
PaymentPaypalAccountIDstring nullable
PaymentCreditCardLast4string nullable
PaymentMerchantReferenceNumberstring nullable
ShippingTitlestring nullable
ShippingFirstNamestring nullable
ShippingLastNamestring nullable
ShippingSuffixstring nullable
ShippingCompanyNamestring nullable
ShippingCompanyJobTitlestring nullable
ShippingDaytimePhonestring nullable
ShippingEveningPhonestring nullable
ShippingAddressLine1string nullable
ShippingAddressLine2string nullable
ShippingCitystring nullable
ShippingStateOrProvincestring nullable
ShippingStateOrProvinceNamestring nullable
ShippingPostalCodestring nullable
ShippingCountrystring nullable
BillingTitlestring nullable
BillingFirstNamestring nullable
BillingLastNamestring nullable
BillingSuffixstring nullable
BillingCompanyNamestring nullable
BillingCompanyJobTitlestring nullable
BillingDaytimePhonestring nullable
BillingEveningPhonestring nullable
BillingAddressLine1string nullable
BillingAddressLine2string nullable
BillingCitystring nullable
BillingStateOrProvincestring nullable
BillingStateOrProvinceNamestring nullable
BillingPostalCodestring nullable
BillingCountrystring nullable
PromotionCodestring nullable
PromotionAmountnumber
ShippingAddressType'Undefined' | 'Residential' | 'Commercial'

Example response

{
  "ID": 0,
  "ProfileID": 0,
  "SiteID": 0,
  "SiteName": "string",
  "UserDataPresent": 0,
  "UserDataRemovalDateUTC": "0001-01-01T00:00:00+00:00",
  "SiteAccountID": 0,
  "SiteOrderID": "string",
  "SecondarySiteOrderID": "string",
  "SellerOrderID": "string",
  "CheckoutSourceID": 0,
  "Currency": "string",
  "CreatedDateUtc": "0001-01-01T00:00:00+00:00",
  "ImportDateUtc": "0001-01-01T00:00:00+00:00",
  "UpdatedDateUtc": "0001-01-01T00:00:00+00:00",
  "PublicNotes": "string",
  "PrivateNotes": "string",
  "SpecialInstructions": "string",
  "TotalPrice": 0,
  "TotalTaxPrice": 0,
  "TotalShippingPrice": 0,
  "TotalShippingTaxPrice": 0,
  "TotalInsurancePrice": 0,
  "TotalGiftOptionPrice": 0,
  "TotalGiftOptionTaxPrice": 0,
  "AdditionalCostOrDiscount": 0,
  "EstimatedShipDateUtc": "0001-01-01T00:00:00+00:00",
  "DeliverByDateUtc": "0001-01-01T00:00:00+00:00",
  "RequestedShippingCarrier": "string",
  "RequestedShippingClass": "string",
  "ResellerID": "string",
  "FlagID": 0,
  "FlagDescription": "string",
  "OrderTags": "string",
  "DistributionCenterTypeRollup": "SellerManaged",
  "CheckoutStatus": "NotVisited",
  "PaymentStatus": "NotYetSubmitted",
  "ShippingStatus": "Unshipped",
  "CheckoutDateUtc": "0001-01-01T00:00:00+00:00",
  "PaymentDateUtc": "0001-01-01T00:00:00+00:00",
  "ShippingDateUtc": "0001-01-01T00:00:00+00:00",
  "BuyerUserId": "string",
  "BuyerEmailAddress": "string",
  "BuyerEmailOptIn": true,
  "OrderTaxType": "NoTax",
  "ShippingTaxType": "NoTax",
  "GiftOptionsTaxType": "NoTax",
  "PaymentMethod": "string",
  "PaymentTransactionID": "string",
  "PaymentPaypalAccountID": "string",
  "PaymentCreditCardLast4": "string",
  "PaymentMerchantReferenceNumber": "string",
  "ShippingTitle": "string",
  "ShippingFirstName": "string",
  "ShippingLastName": "string",
  "ShippingSuffix": "string",
  "ShippingCompanyName": "string",
  "ShippingCompanyJobTitle": "string",
  "ShippingDaytimePhone": "string",
  "ShippingEveningPhone": "string",
  "ShippingAddressLine1": "string",
  "ShippingAddressLine2": "string",
  "ShippingCity": "string",
  "ShippingStateOrProvince": "string",
  "ShippingStateOrProvinceName": "string",
  "ShippingPostalCode": "string",
  "ShippingCountry": "string",
  "BillingTitle": "string",
  "BillingFirstName": "string",
  "BillingLastName": "string",
  "BillingSuffix": "string",
  "BillingCompanyName": "string",
  "BillingCompanyJobTitle": "string",
  "BillingDaytimePhone": "string",
  "BillingEveningPhone": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingCity": "string",
  "BillingStateOrProvince": "string",
  "BillingStateOrProvinceName": "string",
  "BillingPostalCode": "string",
  "BillingCountry": "string",
  "PromotionCode": "string",
  "PromotionAmount": 0,
  "ShippingAddressType": "Undefined",
  "ShippingBusinessHours": [
    {
      "@odata.type": "ChannelAdvisor.RestApi.V1.Models.ShippingBusinessHour"
    }
  ]
}

Changes

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