Get Company Shipping APIs

Updated 3 months ago ​by nussi

Overview

In order to get information for the company shipping APIs, you can consume the endpoint presented in this article. 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 to the call.

Endpoint

Example for such endpoint for TT server:

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

For your server endpoint will be:

​https://{your_server_id}.api.sellercloud.com/rest/api/Companies/{id}/ShippingApi

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 (where 'Token' is the token received from the token authentication)
  • Header info: Content-Type: application/json
  • Parameters: ID of existing company

Response

  • If user is authenticated, then response will be Status Code 200 => OK and company shipping APIs metadata in JSON format in the response body
  • If user is not authenticated, then response will be Status Code 401 => Not Valid Token
  • In case of error, the response will be Status Code 500 => Internal Server Error

Response Body Format

{
"UPSApi": {
"ShippingNumber": "string"
},
"FedExApi": {
"ShippingAccountNumber": "string"
},
"FedExApiOld": {
"AccountNumber": "string"
},
"EndiciaApi": {
"AccountID": "string"
}
}


How did we do?