Get List of Package Types

Overview

To get a list of existing Shipping Package Types, you can consume the endpoint presented in this article. To consume it, you must:

  • Be an 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 service call.

Endpoint

Example for such an endpoint for XX server is:

​​https://xx.api.sellercloud.com/rest/api/Settings/ShippingPackageTypes

For your server, the endpoint will be:

​​https://{your_server_id}.api.sellercloud.com/rest/api/Settings/ShippingPackageTypes

Request

  • Method Type: HttpGet
  • Authorization: Use Bearer Token (where ‘Token’ is the token received from the token authentication)
  • Header info: Content-Type: application/json
  • Parameter: Carrier – string, required.

Response

  • If the user is authenticated, then the response will be Status Code 200 => OK and a list of the package types in JSON format in the response body
  • If the user is not authenticated, then the 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

[
  {
    "Key": "string",
    "Value": "string"
  }
]

Was this article helpful?

Next
Set WITR Status to Requested