Get Single Company

Updated 1 week ago ​by nussi

Overview

In order to get information for a single company, you can consume the endpoint presented in this article. In order to consume it, 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 receiving a single company information.

  • Have valid ID of an existing company

Endpoint

Example for such endpoint for TT server is:

https://tt.api.sellercloud.com/rest/api/companies/{id}

For your server endpoint will be:

https://{your_server_id}.api.sellercloud.com/rest/api/companies/{id}

Request

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

Parameter

Data Type

Description

Is Required

id

integer

ID of existing company

Yes

Example: https://tt.api.sellercloud.com/rest/api/companies/1

Response

  • If user is authenticated and provides a valid ID of company, then response will be Status Code 200 => OK and company 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


How did we do?