latestOpenAPI 3.0.0Proprietary2026-08-22131410675.6 KB

8d8a7cf79204

carriers

List carriers

List all carriers that have been added to this account

get/v1/carriers

Query parameters

pageinteger

Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.

page_sizeinteger

The number of results to return per response.

include_extended_detailsboolean

When true (the default), each carrier in the response includes two additional arrays: packages (the package types supported by that carrier) and options (the carrier-level advanced options available for that carrier). Set to false to omit both arrays and reduce response payload size. This is useful when you only need basic carrier information such as carrier_id, balance, or services.

Response

The request was a success.

totalinteger required

The total number of items across all pages of results

pageinteger required

The current page number of results. For example, if there are 80 results, and the page size is 25, then page could be 1, 2, 3, or 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items.

pagesinteger required

The total number of pages of results. For example, if there are 80 results, and the page size is 25, then pages would be 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. If there are no results, then pages will be zero.

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",
          "send_rates": true
        }
      ],
      "packages": [
        {
          "package_id": "se-28529731",
          "package_code": "package",
          "name": "laptop_box",
          "description": "Packaging for laptops"
        }
      ],
      "options": [
        {
          "name": "contains_alcohol",
          "default_value": "false"
        }
      ],
      "send_rates": true
    }
  ],
  "total": 2750,
  "page": 1,
  "pages": 4,
  "links": {
    "first": {
      "href": "https://example.com/resource"
    },
    "last": {
      "href": "https://example.com/resource"
    },
    "prev": {
      "href": "https://example.com/resource"
    },
    "next": {
      "href": "https://example.com/resource"
    }
  },
  "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"
    }
  ]
}