Create New Sales Order

Overview

In order to create a new order from the API you can consume the endpoint presented in this article. In order to consume it, you must:

  • Be authenticated user

For information on how you can authenticate, see: Authentication

Endpoint

Example for such endpoint for TT server is:

https://tt.api.sellercloud.com/rest/api/Orders/

For your server endpoint will be:

​https://{your_server_id}.api.sellercloud.com/rest/api/Orders/

Request

  • Method Type: HttpPost
  • Authorization: Use Bearer Token + token received from token authentication
  • Header info: Content-Type: application/json
  • Parameters: ID of the order
Parameter Data Type Description Is Required
CustomerDetails “CustomerDetails”: {

“ID”: 0,

“Email”: “string”,

“FirstName”: “string”,

“LastName”: “string”,

“Business”: “string”,

“IsWholesale”: true

},

Information about the customer.

FirstName, LastName and Email are mandatory fields.

ID is the unique customer number in SellerCloud system.

IsWholesale indicates if customer is a wholesale.

Yes
OrderDetails “OrderDetails”: {

“CompanyID”: 0,

“MarketingSource”: 0,

“SalesRepresentative”: 0,

“TaxExempt”: true,

“GiftOrder”: true,

“Channel”: “Local_Store”,

“OrderSourceOrderID”: “string”,

“DisableInventoryCount”: true,

“OrderDate”: “2021-02-08T14:04:35.726Z”,

“EbaySellingManagerSalesRecordNumber”: “string”

},

Basic information about the order.

ID of the company is mandatory.

Channel is mandatory:

Local_Store = 0,

Website = 6

Wholesale = 21

DisableInventoryCount – optional, do not provide or set to null if no value needs to be specified.

OrderDate – time of order (optional)

EbaySellingManagerSalesRecordNumber – ebay selling manager sales record number (optional)

Yes
ShippingAddress object Shipping Address

For more information please check swagger.

No
BillingAddress object Billing Address

For more information please check swagger.

No
ShippingMethodDetails object Shipping information like carrier, service method, weight and dimensions, handling, shipping, insurance fee.

For more info please check swagger.

No
Notes object Order notes No
Products List List of products including product ID, name, price, qty, discount etc. No
GiftDetails object Gift information: gift message, gift wrap fee etc.

For more information please check swagger.

No

Important:

Order creation is allowed only for Local Store, Website & Wholesale orders.

Response

  • If user is authenticated and provides a valid ID of an order, then response will be Status Code 200 => OK and order metadata in JSON format
  • If user is not authenticated, then response will be Status Code 401 => Not Valid Token
  • On server response => Status Code 500 => Internal Server Error

Enumerations

Order Note Category

General = 0, Customer_Instructions = 1, Customer_Service_Note = 2

Was this article helpful?

Related Articles