Get All Orders

Overview

In order to get information for many orders in a single request, 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	Page number that will be retrieved. If page number is not set in the request, then only 1st page will be pulled.	No
pageSize	integer	Number of orders per page. If not set in the request, then top 10 orders will be pulled. NOTE: Maximum number of orders that can be pulled with a single call is 50.	No
companyID	List	List of ID of companies	No
orderIDs	List	List of ID of sales orders.	No
orderStatus	List	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
exported	integer	Filters orders based on their exported status. Possible values: All = -1, Yes = 1, No = 0	No
hasParentOrderFilter	integer	Filters orders based on whether they have parent order. Possible values: All = -1, Yes = 1, No = 0	No
dateRange	List	Date range. For supported values check swagger.	No
shipDateRange	List	Range of shipping date. For supported values check swagger.	No
paymentDateRange	List	Range for payment date. For supported values check swagger.	No
dropshipStatus	List	Dropship statuses.	No
DropshipPoNumbers	List	List of dropship purchase order IDs	No
paymentStatus	List	ALL, NoPayment, Charged, PartialRefund, PartiallyPaid etc.	No
orderSourceOrderIDList	Array		No
channel	List	List of Channel IDs	No
orderSubType	string	Type of order: Sample, Charity, Prime etc.	No
shippingStatus	string	Unknown, Unshipped, PartiallyShipped, FullyShipped, ReadyForPickup	No
trackingNumber	string	Tracking number	No
serialNumber	string	Serial number	No
lastUpdatedFrom	DateTime	Date of the last update	No
lastUpdatedTo	DateTime	Date of the last update	No
warehouseID	List	List of warehouse ID	No
companyGroupID	List	List of company group ID	No
keyword	string	A search term for performing a global search. No	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

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

Different status codes can be found in that section here: https://sellercloud.com/developer/dev-category/resources/

Demo in c#

string username = “{your_username}”;
string password = “{your_password}”;

IAuthenticationClient authenticationClient = new AuthenticationClient();
string token = authenticationClient.Login(baseUri, new LoginRequest(username, password));

using (var client = new HttpClient())
{
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue(“Bearer”, token);
var responseMessage = client.GetAsync(url).Result;

var content = responseMessage.Content
.ReadAsStringAsync()
.Result;

return JsonConvert.DeserializeObject<GetAllResponse>(content);
}

var responseMessage = client.SendAsync(request).Result;

var content = responseMessage.Content
.ReadAsStringAsync()
.Result;

var response = JsonConvert.DeserializeObject(content);

return response.access_token;
}
}
}
}

public DateTime? validFrom { get; set; }
public DateTime? validTo { get; set; }
}

public interface IAuthenticationClient
{
string Login(string baseUri, LoginRequest request);
}

public class LoginRequest
{
public LoginRequest(string username, string password)
{
this.Username = username;
this.Password = password;
}

public string Username { get; }

public string Password { get; }
}