Process labels in bulk and receive a large number of labels and customs forms in bulk responses. Batching is ideal for workflows that need to process hundreds or thousands of labels quickly.
curl -i -X GET \ https://docs.shipstation.com/_mock/openapi/v2/carriers \ -H 'api-key: YOUR_API_KEY_HERE'
The request was a success.
The carrier response body
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
A [shipping carrier] , such as fedex
, dhl_express
, stamps_com
, etc.
The account number that the carrier is connected to.
Indicates whether the carrier requires funding to use its services
Nickname given to the account when initially setting up the carrier.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
Is this the primary carrier that is used by default when no carrier is specified in label/shipment creation
Carrier supports multiple packages per shipment
The carrier supports adding custom label messages to an order.
The carrier is disabled by the current ShipStation account's billing plan.
A list of services that are offered by the carrier
A list of package types that are supported by the carrier
A UUID (a.k.a. GUID) that uniquely identifies a resource
The errors associated with the failed API call
The source of the error, as indicated by the name this informs us if the API call failed because of the carrier, the order source, or the ShipStation API itself.
The type of error
The error code specified for the failed API Call
{ "carriers": [ { … } ], "request_id": "aa3d8e8e-462b-4476-9618-72db7f7b7009", "errors": [ { … } ] }
curl -i -X GET \ 'https://docs.shipstation.com/_mock/openapi/v2/carriers/{carrier_id}' \ -H 'api-key: YOUR_API_KEY_HERE'
The request was a success.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
A [shipping carrier] , such as fedex
, dhl_express
, stamps_com
, etc.
The account number that the carrier is connected to.
Indicates whether the carrier requires funding to use its services
Nickname given to the account when initially setting up the carrier.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
Is this the primary carrier that is used by default when no carrier is specified in label/shipment creation
Carrier supports multiple packages per shipment
The carrier supports adding custom label messages to an order.
The carrier is disabled by the current ShipStation account's billing plan.
A list of package types that are supported by the carrier
{ "carrier_id": "se-8412", "carrier_code": "dhl_express", "account_number": "account_570827", "requires_funded_amount": true, "balance": 3799.52, "nickname": "ShipStation Account - Stamps.com", "friendly_name": "Stamps.com", "funding_source_id": "se-28529731", "primary": true, "has_multi_package_supporting_services": true, "supports_label_messages": true, "disabled_by_billing_plan": true, "services": [ { … } ], "packages": [ { … } ], "options": [ { … } ] }
curl -i -X GET \ 'https://docs.shipstation.com/_mock/openapi/v2/carriers/{carrier_id}/options' \ -H 'api-key: YOUR_API_KEY_HERE'
{ "options": [ { … } ] }
curl -i -X GET \ 'https://docs.shipstation.com/_mock/openapi/v2/carriers/{carrier_id}/packages' \ -H 'api-key: YOUR_API_KEY_HERE'
{ "packages": [ { … } ] }
curl -i -X GET \ 'https://docs.shipstation.com/_mock/openapi/v2/carriers/{carrier_id}/services' \ -H 'api-key: YOUR_API_KEY_HERE'
{ "services": [ { … } ] }
Webhooks are a powerful feature that can save you from sending repeated polling requests to check on the state of something. With webhooks, ShipStation will automatically contact your servers when the stage changes. This can include parcel tracking events, notification when a batch operation completes, and more.