Get All Orders

Overview

In order to retrieve metadata for existing orders, you must:

  • Be authenticated user

Information how you can authenticate can take from: 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/order/getall?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

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


How did we do?