GET Services

• The Get Service API provides information about various shipping services offered by different carriers and providers. This API allows you to retrieve details about available services, such as service names, carriers, providers, codes, and more. Use the API to integrate shipping service information into your applications and services.
• This endpoint retrieves a list of all available shipping services.

Endpoint details

 Endpoint cURL:

curl --location 'https://api-ppd.kloudship.com:960/api/v1/MetaData/Service' \
--header 'Authorization: ••••••'

Response fields:

The API response will include an array of service objects with the following attributes:

1. `id` (string): The unique identifier for the service.
2. `service` (string): The type of service (e.g., Surface, Express, Local).
3. `carrier` (string): The name of the carrier offering the service.
4. `provider` (string): The provider of the service.
5. `status` (string): The status of the service (e.g., Public).
6. `carrierSpecificCode` (object): An object containing carrier-specific information.
7. `name` (string): The name of the carrier-specific code.
8. `code` (string): The code associated with the carrier-specific code.
9. `name` (string): The name of the service.
10. `isInternational` (boolean): Indicates whether the service is international.
11. `maxSupportedWeight` (number): The maximum supported weight for the service.
12. `iconText` (string): Text associated with an icon for the service.
13. `bannerText` (string): Text associated with a banner for the service.

Example Response:

[
 {
        "id": "687a4ba46ee5ee0dac6a1957",
        "service": "Surface",
        "carrier": "EkartElite",
        "provider": "Native",
        "status": "Public",
        "carrierSpecificCode": {
            "name": "Surface",
            "code": "SURFACE"
        },
        "name": "Ekart Elite Surface",
        "isInternational": false,
        "maxSupportedWeight": 100,
        "iconText": "",
        "bannerText": ""
    },
    {
        "id": "6870b6d93ae971950acc28f6",
        "service": "Surface",
        "carrier": "ShreeMaruti",
        "provider": "Native",
        "status": "Public",
        "carrierSpecificCode": {
            "name": "Surface",
            "code": "Surface"
        },
        "name": "ShreeMaruti Surface",
        "isInternational": false,
        "maxSupportedWeight": 0,
        "iconText": "",
        "bannerText": ""
    },
    {
        "id": "6870b6b33ae971950acc28f5",
        "service": "Express",
        "carrier": "ShreeMaruti",
        "provider": "Native",
        "status": "Public",
        "carrierSpecificCode": {
            "name": "Air",
            "code": "Air"
        },
        "name": "ShreeMaruti Express",
        "isInternational": false,
        "maxSupportedWeight": 0,
        "iconText": "",
        "bannerText": ""
    },
 //.....Other services
]

Error Responses

401 Unauthorized: Authentication token is missing or invalid.

{
  "error": "Unauthorized",
  "message": "Authentication token is missing or invalid."
}

Not Yet Signed Up?

• Get started with KloudShip - This article explains steps like signing up, KYC, and adding balance to your account