carriers

List carriers

List all carriers that have been added to this account.

get/v2/carriers

Request

  • Base URL: https://api.shipstation.com
  • URL: https://api.shipstation.com/v2/carriers
  • Auth: API key in header api-key

Response

The request was a success.

request_idstring uuid required

A UUID (a.k.a. GUID) that uniquely identifies a resource

Example response

{
  "carriers": [
    {
      "carrier_id": "se-28529731",
      "carrier_code": "dhl_express",
      "account_number": "account_570827",
      "requires_funded_amount": true,
      "balance": 3799.52,
      "nickname": "ShipStation Account - Stamps.com",
      "friendly_name": "Stamps.com",
      "funding_source_id": "se-28529731",
      "primary": true,
      "has_multi_package_supporting_services": true,
      "supports_label_messages": true,
      "disabled_by_billing_plan": true,
      "services": [
        {
          "carrier_id": "se-28529731",
          "carrier_code": "se-28529731",
          "service_code": "usps_media_mail",
          "name": "USPS First Class Mail",
          "domestic": true,
          "international": true,
          "is_multi_package_supported": true
        }
      ],
      "packages": [
        {
          "package_id": "se-28529731",
          "package_code": "small_flat_rate_box",
          "name": "laptop_box",
          "dimensions": {
            "length": 2,
            "width": 2,
            "height": 1
          },
          "description": "Packaging for laptops"
        }
      ],
      "options": [
        {
          "name": "contains_alcohol",
          "default_value": "false",
          "description": "The description"
        }
      ],
      "send_rates": true,
      "supports_user_managed_rates": true
    }
  ],
  "request_id": "aa3d8e8e-462b-4476-9618-72db7f7b7009",
  "errors": [
    {
      "message": "Body of request cannot be null."
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.