Carrier Metadata

The Carrier Metadata endpoint returns information about all the carriers available on the EasyPost platform. This information may include service levels, predefined packages, shipment options, supported features, and more that are available per carrier. This metadata can be useful during onboarding and integration or when determining the ideal carrier mix for your setup.

Endpoints

GET

/metadata/carriers

CarrierMetadata object

carrier

string

The single-word name of a carrier, such as "royalmail"

human_readable

string

The human-readable name of the carrier

service_levels

array

A list of service level objects for this carrier

predefined_packages

array

A list of predefined package objects for this carrier

supported_features

array

A list of supported feature objects for this carrier

shipment_options

array

A list of shipment option objects for this carrier

CarrierMetadata Object

{
  "human_readable": "USPS",
  "name": "usps",
  "predefined_packages": [
    {
      "carrier": "usps",
      "description": null,
      "dimensions": [
        "6in x 4.5in x 0.016in"
      ],
      "human_readable": null,
      "max_weight": null,
      "name": "Card"
    },
    {
      "carrier": "usps",
      "description": null,
      "dimensions": [
        "11.5in x 6.125in x 0.25in"
      ],
      "human_readable": null,
      "max_weight": null,
      "name": "Letter"
    },
    {
      "carrier": "usps",
      "description": null,
      "dimensions": [
        "11.5in x 6.125in x 0.75in"
      ],
      "human_readable": null,
      "max_weight": null,
      "name": "Flat"
    },
    {
      "carrier": "usps",
      "description": null,
      "dimensions": [
        "12.5in x 9.5in"
      ],
      "human_readable": null,
      "max_weight": null,
      "name": "FlatRateEnvelope"
    },
    {
      "carrier": "usps",
      "description": null,
      "dimensions": [
        "15in x 9.5in"
      ],
      "human_readable": null,
      "max_weight": null,
      "name": "FlatRateLegalEnvelope"
    },
    {
      "carrier": "usps",
      "description": null,
      "dimensions": [
        "12.5in x 9.5in"
      ],
      "human_readable": null,
      "max_weight": null,
      "name": "FlatRatePaddedEnvelope"
    },
    {
      "carrier": "usps",
      "description": null,
      "dimensions": [
        "10in x 5in",
        "12.5in x 9.5in"
      ],
      "human_readable": null,
      "max_weight": null,
      "name": "FlatRateWindowEnvelope"
    },
    {
      "carrier": "usps",
      "description": null,
      "dimensions": [
        "12.5in x 9.5in"
      ],
      "human_readable": null,
      "max_weight": null,
      "name": "FlatRateCardboardEnvelope"
    },
    {
      "carrier": "usps",
      "description": null,
      "dimensions": [
        "10in x 6in"
      ],
      "human_readable": null,
      "max_weight": null,
      "name": "SmallFlatRateEnvelope"
    },
    {
      "carrier": "usps",
      "description": null,
      "dimensions": [
        "Varies based on service level"
      ],
      "human_readable": null,
      "max_weight": null,
      "name": "Parcel"
    },
    {
      "carrier": "usps",
      "description": null,
      "dimensions": [
        "Varies based on service level"
      ],
      "human_readable": null,
      "max_weight": 320,
      "name": "SoftPack"
    },
    {
      "carrier": "usps",
      "description": null,
      "dimensions": [
        "8.6875in x 5.4375in x 1.75in"
      ],
      "human_readable": null,
      "max_weight": null,
      "name": "SmallFlatRateBox"
    },
    {
      "carrier": "usps",
      "description": null,
      "dimensions": [
        "11.25in x 8.75in x 6in",
        "14.125in x 12in x 3.5in"
      ],
      "human_readable": null,
      "max_weight": null,
      "name": "MediumFlatRateBox"
    },
    {
      "carrier": "usps",
      "description": null,
      "dimensions": [
        "12.25in x 12in x 6in"
      ],
      "human_readable": null,
      "max_weight": null,
      "name": "LargeFlatRateBox"
    },
    {
      "carrier": "usps",
      "description": null,
      "dimensions": [
        "12.25in x 12.25in x 6in"
      ],
      "human_readable": null,
      "max_weight": null,
      "name": "LargeFlatRateBoxAPOFPO"
    },
    {
      "carrier": "usps",
      "description": null,
      "dimensions": [],
      "human_readable": null,
      "max_weight": null,
      "name": "FlatTubTrayBox"
    },
    {
      "carrier": "usps",
      "description": null,
      "dimensions": [],
      "human_readable": null,
      "max_weight": null,
      "name": "EMMTrayBox"
    },
    {
      "carrier": "usps",
      "description": null,
      "dimensions": [],
      "human_readable": null,
      "max_weight": null,
      "name": "FullTrayBox"
    },
    {
      "carrier": "usps",
      "description": null,
      "dimensions": [],
      "human_readable": null,
      "max_weight": null,
      "name": "HalfTrayBox"
    },
    {
      "carrier": "usps",
      "description": null,
      "dimensions": [],
      "human_readable": null,
      "max_weight": null,
      "name": "PMODSack"
    }
  ],
  "service_levels": [
    {
      "carrier": "usps",
      "description": "1-5 business days",
      "dimensions": [
        "Cards, Letters and Flats only (no Parcels)",
        "See Predefined Packages (Card, Letter, Flat) for details"
      ],
      "human_readable": "First-Class Mail®",
      "max_weight": 13,
      "name": "First"
    },
    {
      "carrier": "usps",
      "description": "1-3 business days",
      "dimensions": [
        "Combined Length and Girth < 108in"
      ],
      "human_readable": "Priority Mail®",
      "max_weight": 1120,
      "name": "Priority"
    },
    {
      "carrier": "usps",
      "description": "1-2 days",
      "dimensions": [
        "Combined Length and Girth < 108in"
      ],
      "human_readable": "Priority Mail Express®",
      "max_weight": 1120,
      "name": "Express"
    },
    {
      "carrier": "usps",
      "description": "2-5 days",
      "dimensions": [
        "Combined Length and Girth < 130in"
      ],
      "human_readable": "USPS Ground Advantage®",
      "max_weight": 70,
      "name": "GroundAdvantage"
    },
    {
      "carrier": "usps",
      "description": "2-8 business days",
      "dimensions": [
        "Combined Length and Girth < 108in"
      ],
      "human_readable": "Library Mail®",
      "max_weight": 1120,
      "name": "LibraryMail"
    },
    {
      "carrier": "usps",
      "description": "2-8 business days",
      "dimensions": [
        "Combined Length and Girth < 108in"
      ],
      "human_readable": "Media Mail®",
      "max_weight": 1120,
      "name": "MediaMail"
    },
    {
      "carrier": "usps",
      "description": null,
      "dimensions": [
        "Must be rectangular, otherwise an additional charge may apply."
      ],
      "human_readable": "First-Class Mail International®",
      "max_weight": 15.994,
      "name": "FirstClassMailInternational"
    },
    {
      "carrier": "usps",
      "description": "7-21 days",
      "dimensions": [
        "Packages (Other Than Rolls): Combined Length and Girth < 108in",
        "Rolls (Tubes): Length: min 4in; max 36 in. Length plus twice the diameter (combined): min 6.75 in; max 42in.",
        "Some countries have specific prohibitions and restrictions"
      ],
      "human_readable": "First-Class Package International Service®",
      "max_weight": 64,
      "name": "FirstClassPackageInternationalService"
    },
    {
      "carrier": "usps",
      "description": "6-10 business days",
      "dimensions": [
        "Combined Length and Girth < 108in"
      ],
      "human_readable": "Priority Mail International®",
      "max_weight": 1120,
      "name": "PriorityMailInternational"
    },
    {
      "carrier": "usps",
      "description": "3-5 business days",
      "dimensions": [
        "Combined Length and Girth < 108in"
      ],
      "human_readable": "Priority Mail Express International®",
      "max_weight": 1120,
      "name": "ExpressMailInternational"
    }
  ]
}

Retrieve Carrier Metadata

Retrieve all CarrierMetadata for all carriers on the EasyPost platform. Optionally, filter the response by specifying a list of carriers or metadata types.

Request Parameters

carriers

i.e. "usps,fedex,ups"

A comma-delimited list of single-word carriers you'd like to filter the response by

types

i.e. "service_levels,predefined_packages"

A comma-delimited list of the metadata types you'd like to filter the response by

GET /metadata/carriers

1# Request all metadata for all carriers
2curl -X GET https://api.easypost.com/v2/metadata/carriers \
3  -u "EASYPOST_API_KEY":
4
5# Request specific metadata for specific carriers
6curl -X GET "https://api.easypost.com/v2/metadata/carriers?carriers=usps&types=service_levels,predefined_packages" \
7  -u "EASYPOST_API_KEY":

Response

1{
2  "carriers": [
3    {
4      "human_readable": "USPS",
5      "name": "usps",
6      "predefined_packages": [
7        {
8          "carrier": "usps",
9          "description": null,
10          "dimensions": ["6in x 4.5in x 0.016in"],
11          "human_readable": null,
12          "max_weight": null,
13          "name": "Card"
14        },
15        {
16          "carrier": "usps",
17          "description": null,
18          "dimensions": ["11.5in x 6.125in x 0.25in"],
19          "human_readable": null,
20          "max_weight": null,
21          "name": "Letter"
22        },
23        {
24          "carrier": "usps",
25          "description": null,
26          "dimensions": ["11.5in x 6.125in x 0.75in"],
27          "human_readable": null,
28          "max_weight": null,
29          "name": "Flat"
30        },
31        {
32          "carrier": "usps",
33          "description": null,
34          "dimensions": ["12.5in x 9.5in"],
35          "human_readable": null,
36          "max_weight": null,
37          "name": "FlatRateEnvelope"
38        },
39        {
40          "carrier": "usps",
41          "description": null,
42          "dimensions": ["15in x 9.5in"],
43          "human_readable": null,
44          "max_weight": null,
45          "name": "FlatRateLegalEnvelope"
46        },
47        {
48          "carrier": "usps",
49          "description": null,
50          "dimensions": ["12.5in x 9.5in"],
51          "human_readable": null,
52          "max_weight": null,
53          "name": "FlatRatePaddedEnvelope"
54        },
55        {
56          "carrier": "usps",
57          "description": null,
58          "dimensions": ["10in x 5in", "12.5in x 9.5in"],
59          "human_readable": null,
60          "max_weight": null,
61          "name": "FlatRateWindowEnvelope"
62        },
63        {
64          "carrier": "usps",
65          "description": null,
66          "dimensions": ["12.5in x 9.5in"],
67          "human_readable": null,
68          "max_weight": null,
69          "name": "FlatRateCardboardEnvelope"
70        },
71        {
72          "carrier": "usps",
73          "description": null,
74          "dimensions": ["10in x 6in"],
75          "human_readable": null,
76          "max_weight": null,
77          "name": "SmallFlatRateEnvelope"
78        },
79        {
80          "carrier": "usps",
81          "description": null,
82          "dimensions": ["Varies based on service level"],
83          "human_readable": null,
84          "max_weight": null,
85          "name": "Parcel"
86        },
87        {
88          "carrier": "usps",
89          "description": null,
90          "dimensions": ["Varies based on service level"],
91          "human_readable": null,
92          "max_weight": 320.0,
93          "name": "SoftPack"
94        },
95        {
96          "carrier": "usps",
97          "description": null,
98          "dimensions": ["8.6875in x 5.4375in x 1.75in"],
99          "human_readable": null,
100          "max_weight": null,
101          "name": "SmallFlatRateBox"
102        },
103        {
104          "carrier": "usps",
105          "description": null,
106          "dimensions": ["11.25in x 8.75in x 6in", "14.125in x 12in x 3.5in"],
107          "human_readable": null,
108          "max_weight": null,
109          "name": "MediumFlatRateBox"
110        },
111        {
112          "carrier": "usps",
113          "description": null,
114          "dimensions": ["12.25in x 12in x 6in"],
115          "human_readable": null,
116          "max_weight": null,
117          "name": "LargeFlatRateBox"
118        },
119        {
120          "carrier": "usps",
121          "description": null,
122          "dimensions": ["12.25in x 12.25in x 6in"],
123          "human_readable": null,
124          "max_weight": null,
125          "name": "LargeFlatRateBoxAPOFPO"
126        },
127        {
128          "carrier": "usps",
129          "description": null,
130          "dimensions": [],
131          "human_readable": null,
132          "max_weight": null,
133          "name": "FlatTubTrayBox"
134        },
135        {
136          "carrier": "usps",
137          "description": null,
138          "dimensions": [],
139          "human_readable": null,
140          "max_weight": null,
141          "name": "EMMTrayBox"
142        },
143        {
144          "carrier": "usps",
145          "description": null,
146          "dimensions": [],
147          "human_readable": null,
148          "max_weight": null,
149          "name": "FullTrayBox"
150        },
151        {
152          "carrier": "usps",
153          "description": null,
154          "dimensions": [],
155          "human_readable": null,
156          "max_weight": null,
157          "name": "HalfTrayBox"
158        },
159        {
160          "carrier": "usps",
161          "description": null,
162          "dimensions": [],
163          "human_readable": null,
164          "max_weight": null,
165          "name": "PMODSack"
166        }
167      ],
168      "service_levels": [
169        {
170          "carrier": "usps",
171          "description": "1-5 business days",
172          "dimensions": [
173            "Cards, Letters and Flats only (no Parcels)",
174            "See Predefined Packages (Card, Letter, Flat) for details"
175          ],
176          "human_readable": "First-Class Mail\u00ae",
177          "max_weight": 13.0,
178          "name": "First"
179        },
180        {
181          "carrier": "usps",
182          "description": "1-3 business days",
183          "dimensions": ["Combined Length and Girth < 108in"],
184          "human_readable": "Priority Mail\u00ae",
185          "max_weight": 1120.0,
186          "name": "Priority"
187        },
188        {
189          "carrier": "usps",
190          "description": "1-2 days",
191          "dimensions": ["Combined Length and Girth < 108in"],
192          "human_readable": "Priority Mail Express\u00ae",
193          "max_weight": 1120.0,
194          "name": "Express"
195        },
196        {
197          "carrier": "usps",
198          "description": "2-5 days",
199          "dimensions": ["Combined Length and Girth < 130in"],
200          "human_readable": "USPS Ground Advantage\u00ae",
201          "max_weight": 70.0,
202          "name": "GroundAdvantage"
203        },
204        {
205          "carrier": "usps",
206          "description": "2-8 business days",
207          "dimensions": ["Combined Length and Girth < 108in"],
208          "human_readable": "Library Mail\u00ae",
209          "max_weight": 1120.0,
210          "name": "LibraryMail"
211        },
212        {
213          "carrier": "usps",
214          "description": "2-8 business days",
215          "dimensions": ["Combined Length and Girth < 108in"],
216          "human_readable": "Media Mail\u00ae",
217          "max_weight": 1120.0,
218          "name": "MediaMail"
219        },
220        {
221          "carrier": "usps",
222          "description": null,
223          "dimensions": ["Must be rectangular, otherwise an additional charge may apply."],
224          "human_readable": "First-Class Mail International\u00ae",
225          "max_weight": 15.994,
226          "name": "FirstClassMailInternational"
227        },
228        {
229          "carrier": "usps",
230          "description": "7-21 days",
231          "dimensions": [
232            "Packages (Other Than Rolls): Combined Length and Girth < 108in",
233            "Rolls (Tubes): Length: min 4in; max 36 in. Length plus twice the diameter (combined): min 6.75 in; max 42in.",
234            "Some countries have specific prohibitions and restrictions"
235          ],
236          "human_readable": "First-Class Package International Service\u00ae",
237          "max_weight": 64.0,
238          "name": "FirstClassPackageInternationalService"
239        },
240        {
241          "carrier": "usps",
242          "description": "6-10 business days",
243          "dimensions": ["Combined Length and Girth < 108in"],
244          "human_readable": "Priority Mail International\u00ae",
245          "max_weight": 1120.0,
246          "name": "PriorityMailInternational"
247        },
248        {
249          "carrier": "usps",
250          "description": "3-5 business days",
251          "dimensions": ["Combined Length and Girth < 108in"],
252          "human_readable": "Priority Mail Express International\u00ae",
253          "max_weight": 1120.0,
254          "name": "ExpressMailInternational"
255        }
256      ]
257    }
258  ]
259}