Skip to main content

Carriers API

List and query available carriers and their services.

List carriers​

GET /v1/carriers

Returns all carriers available in your workspace.

Get carrier details​

GET /v1/carriers/:code

Response​

{
  "code": "usps",
  "name": "United States Postal Service",
  "services": [
    {
      "code": "priority",
      "name": "Priority Mail",
      "transitDays": { "min": 1, "max": 3 },
      "maxWeightOz": 1120,
      "supportsInternational": false,
      "supportsInsurance": true,
      "supportsSignatureConfirmation": true
    },
    {
      "code": "express",
      "name": "Priority Mail Express",
      "transitDays": { "min": 1, "max": 2 },
      "maxWeightOz": 1120,
      "supportsInternational": true,
      "supportsInsurance": true,
      "supportsSignatureConfirmation": true,
      "guaranteedDelivery": true
    }
  ],
  "supportsReturns": true,
  "supportsPickup": false,
  "supportsAddressValidation": true
}