Get All Orders

Overview

In order to get information for many orders in a single request, then you can consume the endpoint presented in this article. However in order to do that, you must:

  • Be authenticated user

For information on how you can authenticate, see: Authentication

As soon as you do authentication and receive a valid token, it needs to be passed on the call for getting orders.

  • You can provide page number and page size and some filtering information

Endpoint

Example for such endpoint for TT server:

https://tt.api.sellercloud.com/rest/api/orders?pageNumber=1&pageSize=1

For your server endpoint will be:

​https://{your_server_id}.api.sellercloud.com/rest/api/orders?pageNumber=1&pageSize=1

Request

Information about expected request parameters can be found on swagger UI https://tt/api.sellercloud.com/rest/swagger.

  • Method Type: HttpGet
  • Authorization: Use Bearer Token + token received from token authentication
  • Header info: Content-Type: application/json
  • Parameters:

Parameters

Data Type

Description

Is Required

pageNumber

integer

Number of page

yes

pageSize

integer

Number of orders per page

yes

companyID

List<integer>

List of ID of companies

No

orderIDs

List<integer>

List of ID of sales orders.

No

orderStatus

List<string>

Cancelled, ShoppingCart, Completed, InProcess, ProblemOrder, OnHold, Quote, Void

No

sku

string

ID of inventory

no

createdOnFrom

DateTime

Minimum date of creation

No

createdOnTo

DateTime

Maximum date of creation

No

dateRange

List<string>

Date range. For supported values check swagger.

No

shipDateRange

List<string>

Range of shipping date. For supported values check swagger.

No

paymentDateRange

List<string>

Range for payment date. For supported values check swagger.

No

dropshipStatus

List<string>

Dropship statuses.

No

paymentStatus

List<string>

ALL, NoPayment, Charged, PartialRefund, PartiallyPaid etc.

No

orderSourceOrderIDList

Array<string>

No

channel

string

Channel: Amazon, eBay etc.

No

orderSubType

string

Type of order: Sample, Charity, Prime etc.

No

shippingStatus

string

Unknown, Unshipped, PartiallyShipped, FullyShipped, ReadyForPickup

No

lastUpdatedFrom

DateTime

Date of the last update

No

lastUpdatedTo

DateTime

Date of the last update

No

warehouseID

List<int>

List of warehouse ID

No

Response

  • If user is authenticated and provides a valid page number and page size, then response will be Status Code 200 => OK and orders metadata in JSON format
{ 
"Items": [],
TotalResults: 0
}

  • If user is not authenticated, then response will be Status Code 401 => Not Valid Token
  • On server response => Status Code 500 => Internal Server Error

OrderSubType feld options:

None = 0,
Sample = 1,
Charity = 2,
eBayNow = 3,
eBayLocalPickup = 4,
Same_Day_Delivery = 5,
GS = 6,
Prime = 7,
FBA_Exchange = 8,
Amazon_Business = 9,
Amazon_Business_Prime = 10,
Second_Day = 11,
Wish_Express = 12,
SBN = 13


How did we do?