API - Carrier Account

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

GET: Carrier Account

This API provides all carrier account integrated in CSA

EndPoint details:

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

Request Body:

This API does not require any request parameters

cURL:

curl --location 'https://api-ppd.kloudship.com:960/api/v1/CarrierAccount/Provider/Native' \
--header 'Authorization: ••••••'

Response fields:

results: Consists array of objects of all carrier accounts
id: id of carrier account
createdDate: Date on which this carrier account was created
name: Name of carrier account
carrier: Carrier name of carrier account
provider: name of carrier provider
status: Status of carrier Enabled/Disabled
category: Native/ your own carrier
carrierCredentials: Carrier credentials used to get token
contacts: Any support contact if present

Response example:

{
 "results": [
        {
            "id": "68e02252392381e9215a83a3",
            "createdDate": "2025-10-03T19:21:54.975Z",
            "name": "Porter",
            "carrier": "Porter",
            "provider": "Native",
            "status": "Enabled",
            "category": "Native",
            "carrierCredentials": [
                {
                    "token": "*********",
                    "isTest": true
                },
                {
                    "token": "*********",
                    "isTest": false
                }
            ],
            "contacts": []
        },
  //...More carrier accounts
 ],
   "pageSize": 20,
    "totalResults": 7,
    "totalPages": 1,
    "currentPage": 1
 }
}

GET: Carrier account by Id

This API provides any particular carrier account fetched by its id

EndPoint details:

Method	POST
Production Environment URL	https://api.kloudship.com/api/v1/CarrierAcco unt/{id}
Test Environment URL	https://api-ppd.kloudship.com:960/api/v1 /CarrierAccount/{id}
Content-Type	application/json

cURL:

curl --location 'https://api-ppd.kloudship.com:960/api/v1/CarrierAccount/{id}' \
--header 'Authorization: ••••••'

Response fields:

results: Consists array of objects of all carrier accounts
id: id of carrier account
createdDate: Date on which this carrier account was created
name: Name of carrier account
carrier: Carrier name of carrier account
provider: name of carrier provider
status: Status of carrier Enabled/Disabled
category: Native/ your own carrier
carrierCredentials: Carrier credentials used to get token
contacts: Any support contact if present

Response example:

{
    "id": "68e02252392381e9215a83a3",
    "createdDate": "2025-10-03T19:21:54.975Z",
    "name": "Porter",
    "carrier": "Porter",
    "provider": "Native",
    "status": "Enabled",
    "category": "Native",
    "carrierCredentials": [
        {
            "token": "**********",
            "isTest": true
        },
        {
            "token": "*********",
            "isTest": false
        }
    ],
    "contacts": []
}

Not Yet Signed Up?

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