Get All Companies

Updated 2 months ago ​by nussi

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:

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

  • 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/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.

  • 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 companies per page

yes

companyID

List<integer>

List of ID of companies

no

channel

List<int>

List of channels for which company is enabled for

no

Response

  • If user is authenticated and provides a valid page number and page size, then response will be Status Code 200 => OK and companies 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?