GET - Carriers

Created by KloudShip Support, Modified on Fri, 24 Oct at 7:31 PM by KloudShip Support

The Get Carrier API provides information about various carriers and their details, including carrier codes, names, descriptions, and supported label file types. This API is useful for retrieving information about available carriers for shipping and tracking purposes.
Retrieves a list of carriers along with their details.

Endpoint details

Method	POST
Production Environment URL	https://api.kloudship.com/api/v1/MetaData/Carrier
Test Environment URL	https://api-ppd.kloudship.com:960/api/v1/MetaData/Carrier
Content-Type	application/json

Request Body:

Do not required any request parameter to get MetaData Carriers

cURL:

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

Response Fields:

`id` (string): The unique identifier for the carrier.
`code` (string): The code representing the carrier.
`carrier` (string): The name of the carrier.
`provider` (string): The provider of the carrier's services.
`type` (string): Type of carrier (B2B, B2C etc)
`name` (string): The full name of the carrier.
`logo` (string): URL to the carrier's logo image.
`description` (string): A brief description of the carrier and its affiliation.
`trackingUrl` (string): URL to the carrier's tracking page.
`supportedLabelFileTypes` (array of strings): List of supported label file types (e.g., "PDF")
`scope` (enum): Public, Private
`status` (enum): Enabled, disabled
`url` (string): URL of Carrier Documentation
`contacts` (array of objects): Contains support contacts of carrier

Example response:

[
    {
        "categorySupported": "Both",
        "id": "68b9811a02350ee4de57c749",
        "code": "DelhiveryB2B",
        "carrier": "DelhiveryB2B",
        "provider": "Native",
        "type": "B2B-RC",
        "name": "Delhivery B2B RC",
        "logo": "https://kloudship-public-assets.s3.amazonaws.com/img-delhivery.png",
        "description": "Delhivery B2B carrier helps businesses ...",
        "trackingUrl": "https://www.delhivery.com/track-v2/lr/{awbNumber}",
        "supportedLabelFileTypes": [
            "PDF",
            "PNG"
        ],
        "scope": "Public",
        "status": "Enabled",
        "url": "https://kloudship.freshdesk.com/support/solutions/articles/1060000078887-kloudship-carrier-integration",
        "contacts": [
            {
                "isActive": false,
                "createdDate": "0001-01-01T00:00:00Z",
                "id": "683d857bf2ccbf1f6995a998",
                "locationName": "Delhivery IVR Helpline",
                "contactName": "",
                "phoneCode": "+91",
                "phone": "8069856101",
                "email": ""
            }
        ]
    },
    {
        "categorySupported": "Both",
        "id": "687a26895b268afb9587794c",
        "code": "EkartElite",
        "carrier": "EkartElite",
        "provider": "Native",
        "type": "B2C",
        "name": "Ekart Elite",
        "logo": "https://kloudship-public-assets.s3.amazonaws.com/img-ekart.png",
        "description": "Ekart Elite, one of India’s leading ...",
        "trackingUrl": "https://app.elite.ekartlogistics.in/track/{awbNumber}",
        "supportedLabelFileTypes": [
            "PDF",
            "PNG"
        ],
        "scope": "Public",
        "status": "Enabled",
        "url": "https://kloudship.freshdesk.com/support/solutions/articles/1060000078887-kloudship-carrier-integration",
        "contacts": [
            {
                "isActive": false,
                "createdDate": "0001-01-01T00:00:00Z",
                "id": "6836e7c4ba39e7059afe7e01",
                "locationName": "KloudShip Support",
                "contactName": "KloudShip",
                "phoneCode": "+91",
                "phone": "9205607679",
                "email": "support@kloudship.com"
            }
        ]
    },
    {
        "categorySupported": "Both",
        "id": "6870b63c3ae971950acc28f3",
        "code": "ShreeMaruti",
        "carrier": "ShreeMaruti",
        "provider": "Native",
        "type": "B2C",
        "name": "Shree Maruti",
        "logo": "https://kloudship-public-assets.s3.amazonaws.com/img-shreemaruti.png",
        "description": "Shree Maruti Integrated Logistics ...",
        "trackingUrl": "https://shreemaruti.com/track-shipment/",
        "supportedLabelFileTypes": [
            "PDF",
            "PNG"
        ],
        "scope": "Public",
        "status": "Enabled",
        "url": "https://kloudship.freshdesk.com/support/solutions/articles/1060000078887-kloudship-carrier-integration",
        "contacts": [
            {
                "isActive": false,
                "createdDate": "0001-01-01T00:00:00Z",
                "id": "687f464b418dcce97b3ca3d7",
                "locationName": "ShreeMaruti Support",
                "contactName": "ShreeMaruti",
                "phoneCode": "+91",
                "phone": "9712666666",
                "email": "info@shreemaruti.com"
            }
        ]
    },
//....Other carriers
]

Additional Notes:

The `trackingUrl` field provides a link to the carrier's tracking page, if available.
The `supportedLabelFileTypes` field lists the file types supported for labels, such as "PDF"

Not Yet Signed Up?

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