List carriers
Changed onList all carriers that have been added to this account.
Request
- Base URLhttps://api.shipstation.com
- URLhttps://api.shipstation.com/v2/carriers
- AuthAPI key in header api-key
Query parameters
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.
The number of results to return per response.
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.
Example response
{
"carriers": [
{
"carrier_id": "se-28529731",
"carrier_code": "dhl_express",
"account_number": "account_570827",
"connection_status": "approved",
"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": [
{
"carrier_id": "se-28529731",
"carrier_code": "se-28529731",
"service_code": "usps_media_mail",
"name": "USPS First Class Mail",
"domestic": true,
"international": true,
"is_multi_package_supported": true,
"send_rates": true
}
],
"packages": [
{
"package_id": "se-28529731",
"package_code": "small_flat_rate_box",
"name": "laptop_box",
"dimensions": {
"length": 2,
"width": 2,
"height": 1
},
"description": "Packaging for laptops"
}
],
"options": [
{
"name": "contains_alcohol",
"default_value": "false",
"description": "The description"
}
],
"send_rates": true,
"supports_user_managed_rates": true
}
],
"total": 2750,
"page": 1,
"pages": 4,
"links": {
"first": {
"href": "https://example.com/resource",
"type": "child"
},
"last": {
"href": "https://example.com/resource",
"type": "child"
},
"prev": {
"href": "https://example.com/resource",
"type": "child"
},
"next": {
"href": "https://example.com/resource",
"type": "child"
}
},
"request_id": "aa3d8e8e-462b-4476-9618-72db7f7b7009",
"errors": [
{
"message": "Body of request cannot be null.",
"field_name": "inventory_warehouse_id",
"field_value": "invalid-id"
}
]
}Changes
- warning
added the new
bring_your_own_label_not_supportedenum value to the///response property for the response status - warning
added the new
bring_your_own_label_not_supportedenum value to the///response property for the response status - warning
added the new
bring_your_own_label_not_supportedenum value to the//response property for the response status - warning
added the new
bring_your_own_label_not_supportedenum value to the//response property for the response status - warning
added the new
multiple_sales_ordersenum value to the///response property for the response status - warning
added the new
multiple_sales_ordersenum value to the///response property for the response status - warning
added the new
multiple_sales_ordersenum value to the//response property for the response status - warning
added the new
multiple_sales_ordersenum value to the//response property for the response status - warning
added the new
sales_order_link_requiredenum value to the///response property for the response status - warning
added the new
sales_order_link_requiredenum value to the///response property for the response status - warning
added the new
sales_order_link_requiredenum value to the//response property for the response status - warning
added the new
sales_order_link_requiredenum value to the//response property for the response status
- warning
- breaking
the response property
////became nullable for the status - breaking
the response property
////became nullable for the status - breaking
the response property
///////became nullable for the status - breaking
the response property
///////became nullable for the status - breaking
added
subschema #2to the////response propertyoneOflist for the response status - breaking
added
subschema #2to the////response propertyoneOflist for the response status - info
removed from the
////response propertyallOflist for the response status - info
removed from the
////response propertyallOflist for the response status
- breaking