Returns a list of shipment carriers.

GET /inventory/shipment-carriers

Group: Inventory › Shipment Carriers · Operation ID: shipmentCarriers

The collection returns the same fields as the get and search endpoints. Names are not unique, so an exact name filter can match several carriers. vendorName is returned but cannot be filtered or ordered on this endpoint. To find the carriers of one vendor, filter vendorId instead.

Open in the interactive reference

Parameters

Name	In	Type	Required	Description
`Api-Version`	header	`"v1"`	yes	The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`.

Query surface

id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
name — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
active — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
vendorId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
Orderable: id, name, active, vendorId, lastModifiedDate
Selectable: id, name, active, vendorId, vendorName, lastModifiedDate

Response

200 Success

Under data, an array of shipmentCarriersRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for the shipment carrier.
`name`	string	no	The name of the carrier, for example 'DHL Express'. Names are not unique, so use id to address one carrier.
`active`	boolean or null	no	Whether the carrier can be selected on new shipments. Absent on carriers created before the active flag existed.
`vendorId`	string or null	no	The unique identifier for the vendor this carrier bills through. Absent when the carrier has no vendor. See id on GET accounting/vendors/:id.
`vendorName`	string or null	no	The name of the vendor this carrier bills through. Absent when the carrier has no vendor. It is resolved from the vendor at read time and is not stored on the carrier.
`lastModifiedDate`	string (date-time) or null	no	The date and time the carrier record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Statuses

400 — Invalid request or business failure
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
429 — Too many requests
500 — Internal server error