carriers
List carriers
<aside class="access" aria-label="Endpoint access"> <table class="access__table"> <thead> <tr> <th class="access__table-header">Products</th> <th class="access__table-header">Plans</th> </tr> </thead> <tbody> <tr> <td class="access__table-cell access__product"> <img class="access__logo" src="/static/logos/shipstation-api-logo.svg" alt="ShipStation API Logo" loading="lazy" decoding="async"/> <div class="access__sub">Formerly ShipEngine</div> </td> <td class="access__table-cell access__plans"> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-free.md" class="access__plan">Free</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Advanced</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Enterprise</a> </td> </tr> <tr> <td class="access__table-cell"> <img class="access__logo" src="/static/logos/shipstation-logo.svg" alt="ShipStation Logo" loading="lazy" decoding="async"/> </td> <td class="access__table-cell access__plans"> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Free</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Starter</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan">Standard</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan">Premium</a> </td> </tr> </tbody> </table> <footer class="access__footer"> <a class="access__help" href="/apis/@shipstation-v2/docs/getting-started/products-and-plans.md"> Learn about products and plans <img src="/static/icons/external-link.svg" alt="External Link Icon" style="width: 16px;" loading="lazy" decoding="async"/> </a> </footer> </aside>List all carriers that have been added to this account.
get/v2/carriers
Query parameters
pageinteger
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.
page_sizeinteger
The number of results to return per response.
include_extended_detailsboolean
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"
}
]
}