Get All Companies - Sellercloud API Docs

Overview

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

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 companies information.

Endpoint

Example for such endpoint for TT server:

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

For your server endpoint will be:

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

Request

Information about expected request parameters can be found on swagger UI https://tt/api.sellercloud.com/rest/swagger.
Parameters Data Type Description Is Required
pageNumber integer Number of page yes
pageSize integer Number of companies per page yes
companyID List List of ID of companies no
channel List List of channels for which company is enabled for no
keyword string A search term for performing a global search. no

Response

{
   "Items": [],
   "TotalResults": 0
}