List Carriers

This API endpoint returns a list of all your connected carrier accounts, along with helpful information about each account, its options, the services it offers, etc.

Carrier IDs

Each of your carriers has a unique carrierId. You can use the carrierId for many other GigaLogistics endpoints to indicate which account to use.

For example, when creating a label, you can explicitly specify the carrierId that you want to use. This is especially important if you have multiple accounts for the same carrier.

Example

GET /cloud-boot-manager/api/v1/carriers

curl --location --request GET 'https://apis.gigacloudlogistics.com/cloud-boot-manager/api/v1/carriers/' \
--header 'Authorization: __YOUR_ACCESS_TOKEN__'

{
    "success": true,
    "data": [
      {
        "carrierCode": "GLS",
        "carrierId": "GCL-1f907eda3044",
        "requiresFundedAmount": false,
        "balance": null,
        "nickname": "",
        "friendlyName": "",
        "primary": false,
        "hasMultiPackageSupportingServices": false,
        "supportsLabelMessages": true,
        "services": [
          {
            "carrierId": "GCL-1f907eda3044",
            "carrierCode": null,
            "serviceCode": "GLS_STANDARD",
            "name": "GLS standard service",
            "domestic": true,
            "international": true,
            "isMultiPackageSupported": true
          }
        ],
        "packages": [],
        "options": []
      }
    ]
}

If you need to be explicit about these, make sure to pay attention to the carrierId line.

{
  "carrierId": "GCL-1f907eda3044"
}