Skip to main content

Add new order

Add new order

Authorizations:Token
Request Body Schema:
Order object that needs to be added
uspsShipmentArrayUSPS Shipments
capostParcelsArrayCanada Post parcels (reference to the Canada Post parcels model)
capostReturnsArrayReference to the Canada Post returns model
capostOffice
mailchimpStoreIdstringMailchimp store id
not_finished_order
demobooleanFlag, if the product participates in the sale
is_opened_disputebooleanHas opened disputes flag
conversation
childrenArrayList of carts by vendors
parent
vendor
commission
profileTransactionsArrayProfile transactions for shop owner
vendorRatingsArray of objects (Vendor ratings for the order)Vendor ratings for the order
Array
idinteger
ratingstring
typestring
additionDateinteger
orderobject
xcPendingExportboolean
usedCouponsArrayUsed coupons
reviewKey
order_idintegerOrder unique id
profile
orig_profile
shipping_idintegerShipping method unique id
shipping_method_namestringShipping method name
payment_method_namestringPayment method name
trackingstringShipping tracking code
dateintegerOrder creation timestamp
lastRenewDateintegerLast order renew date
paymentStatusobject
idintegerID
codestringStatus code
positionintegerPosition
shippingStatusobject
idintegerID
codestringStatus code
positionintegerPosition
notesstringCustomer notes
adminNotesstringAdmin notes
detailsArrayOrder details
trackingNumbersArrayOrder tracking numbers
eventsArrayOrder events queue
itemsArrayOrder items
surchargesArrayOrder surcharges
payment_transactionsArrayPayment transactions
currency
orderNumberstringUnique order identificator (it is working for orders only, not for cart entities)
recentbooleanRecent flag: true if order's statuses were not changed manually by an administrator, otherwise - false
xcPendingExportbooleanFlag to exporting entities
backorderCompetitorsArrayProfiles
totalstringTotal
subtotalstringSubtotal

Responses

200Success
Response schema:
Success
uspsShipmentArrayUSPS Shipments
capostParcelsArrayCanada Post parcels (reference to the Canada Post parcels model)
capostReturnsArrayReference to the Canada Post returns model
capostOffice
mailchimpStoreIdstringMailchimp store id
not_finished_order
demobooleanFlag, if the product participates in the sale
is_opened_disputebooleanHas opened disputes flag
conversation
childrenArrayList of carts by vendors
parent
vendor
commission
profileTransactionsArrayProfile transactions for shop owner
vendorRatingsArray of objects (Vendor ratings for the order)Vendor ratings for the order
Array
idinteger
ratingstring
typestring
additionDateinteger
orderobject
xcPendingExportboolean
usedCouponsArrayUsed coupons
reviewKey
order_idintegerOrder unique id
profile
orig_profile
shipping_idintegerShipping method unique id
shipping_method_namestringShipping method name
payment_method_namestringPayment method name
trackingstringShipping tracking code
dateintegerOrder creation timestamp
lastRenewDateintegerLast order renew date
paymentStatusobject
idintegerID
codestringStatus code
positionintegerPosition
shippingStatusobject
idintegerID
codestringStatus code
positionintegerPosition
notesstringCustomer notes
adminNotesstringAdmin notes
detailsArrayOrder details
trackingNumbersArrayOrder tracking numbers
eventsArrayOrder events queue
itemsArrayOrder items
surchargesArrayOrder surcharges
payment_transactionsArrayPayment transactions
currency
orderNumberstringUnique order identificator (it is working for orders only, not for cart entities)
recentbooleanRecent flag: true if order's statuses were not changed manually by an administrator, otherwise - false
xcPendingExportbooleanFlag to exporting entities
backorderCompetitorsArrayProfiles
totalstringTotal
subtotalstringSubtotal