v1

latestOpenAPI 3.0.02026-07-1397337495.2 KB
carriers

List Carriers

List all carriers that have been added to this account

get/v1/carriers

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",
      "balance": 3799.52,
      "nickname": "ShipEngine Account - Stamps.com",
      "friendly_name": "Stamps.com",
      "funding_source_id": "se-28529731",
      "services": [
        {
          "carrier_id": "se-28529731",
          "carrier_code": "se-28529731",
          "service_code": "usps_media_mail",
          "name": "USPS First Class Mail"
        }
      ],
      "packages": [
        {
          "package_id": "se-28529731",
          "package_code": "small_flat_rate_box",
          "name": "laptop_box",
          "description": "Packaging for laptops"
        }
      ],
      "options": [
        {
          "name": "contains_alcohol"
        }
      ]
    }
  ],
  "request_id": "aa3d8e8e-462b-4476-9618-72db7f7b7009",
  "errors": [
    {
      "message": "Body of request cannot be null.",
      "carrier_id": "se-28529731",
      "carrier_code": "dhl_express",
      "field_name": "shipment.ship_to.phone_number"
    }
  ]
}