---
title: "List carriers"
method: GET
path: "/v2/carriers"
tags: ["carriers"]
---

# List carriers

`GET /v2/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.

## Query parameters

- `page` integer
- `page_size` integer
- `include_extended_details` boolean

## Response `200`

The request was a success.

- object — An error response body
  - `carriers` Carrier[], required — The carrier response body
    - `carrier_id` string — A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
    - `carrier_code` string — A [shipping carrier] , such as `fedex`, `dhl_express`, `stamps_com`, etc.
    - `account_number` string — The account number that the carrier is connected to.
    - `connection_status` 'pending_approval' | 'approved' — The connection status of the carrier account. Indicates whether the carrier connection is pending approval or has been approved. This only applies to certain carriers; it can be undefined.
    - `requires_funded_amount` boolean — Indicates whether the carrier requires funding to use its services
    - `balance` number — Current available balance
    - `nickname` string — Nickname given to the account when initially setting up the carrier.
    - `friendly_name` string — Screen readable name
    - `funding_source_id` string — A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
    - `primary` boolean — Is this the primary carrier that is used by default when no carrier is specified in label/shipment creation
    - `has_multi_package_supporting_services` boolean — Carrier supports multiple packages per shipment
    - `supports_label_messages` boolean — The carrier supports adding custom label messages to an order.
    - `disabled_by_billing_plan` boolean — The carrier is disabled by the current ShipStation account's billing plan.
    - `services` Service[] — A list of services that are offered by the carrier
      - `carrier_id` string — A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
      - `carrier_code` string — A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
      - `service_code` string — service code
      - `name` string — User friendly service name
      - `domestic` boolean — Supports domestic shipping
      - `international` boolean — Supports international shipping.
      - `is_multi_package_supported` boolean — Carrier supports multiple packages per shipment
      - `send_rates` boolean — The service provides rates for the shipment.
    - `packages` PackageType[] — A list of package types that are supported by the carrier
      - `package_id` string — A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
      - `package_code` string, required — A [package type] , such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. Use the code `package` for custom or unknown package types.
      - `name` string, required
      - `dimensions` Dimensions — The dimensions of a package
        - `unit` 'inch' | 'centimeter', required — The dimension units that are supported by ShipStation .
        - `length` number, required — The length of the package, in the specified unit
        - `width` number, required — The width of the package, in the specified unit
        - `height` number, required — The height of the package, in the specified unit
      - `description` string — Provides a helpful description for the custom package.
    - `options` CarrierAdvancedOption[] — A list of options that are available to that carrier
      - `name` string — Name of advanced option
      - `default_value` string — Default value of option
      - `description` string — Description of option
    - `send_rates` boolean — The carrier provides rates for the shipment.
    - `supports_user_managed_rates` boolean — The carrier supports user-managed rates for shipments.
  - `total` integer, required — The total number of items across all pages of results
  - `page` integer, required — The current page number of results. For example, if there are 80 results, and the page size is 25, then `page` could be 1, 2, 3, or 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items.
  - `pages` integer, required — The total number of pages of results. For example, if there are 80 results, and the page size is 25, then `pages` would be 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. If there are no results, then `pages` will be zero.
  - `links` PaginationLink, required — Helpful links to other pages of results
    - `first` Link, required — A link to a related resource, or an empty object if there is no resource to link to
      - `href` string, url — A URL
      - `type` string — The type of resource, or the type of relationship to the parent resource
    - `last` Link, required — A link to a related resource, or an empty object if there is no resource to link to
      - `href` string, url — A URL
      - `type` string — The type of resource, or the type of relationship to the parent resource
    - `prev` OptionalLink, required — A link to a related resource, or an empty object if there is no resource to link to
      - `href` string, url — A URL
      - `type` string — The type of resource, or the type of relationship to the parent resource
    - `next` OptionalLink, required — A link to a related resource, or an empty object if there is no resource to link to
      - `href` string, url — A URL
      - `type` string — The type of resource, or the type of relationship to the parent resource
  - `request_id` string, uuid, required — A UUID (a.k.a. GUID) that uniquely identifies a resource
  - `errors` Error[], required — The errors associated with the failed API call
    - `error_source` 'carrier' | 'order_source' | 'ShipStation' | 'shipengine', required — 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, the ShipStation API itself, or the underlying ShipEngine platform.
    - `error_type` 'account_status' | 'business_rules' | 'validation' | 'security' | 'system' | 'integrations', required — The type of error
    - `error_code` 'auto_fund_not_supported' | 'batch_cannot_be_modified' | 'carrier_conflict' | 'carrier_disconnected' | 'carrier_not_connected' | 'carrier_not_supported' | 'confirmation_not_supported' | 'default_warehouse_cannot_be_deleted' | 'field_conflict' | 'field_value_required' | 'forbidden' | 'identifier_conflict' | 'identifiers_must_match' | 'insufficient_funds' | 'invalid_address' | 'invalid_billing_plan' | 'invalid_field_value' | 'invalid_identifier' | 'invalid_status' | 'invalid_string_length' | 'label_images_not_supported' | 'meter_failure' | 'order_source_not_active' | 'rate_limit_exceeded' | 'refresh_not_supported' | 'request_body_required' | 'return_label_not_supported' | 'settings_not_supported' | 'subscription_inactive' | 'terms_not_accepted' | 'tracking_not_supported' | 'trial_expired' | 'unauthorized' | 'unknown' | 'unspecified' | 'verification_failure' | 'warehouse_conflict' | 'webhook_event_type_conflict' | 'customs_items_required' | 'incompatible_paired_labels' | 'invalid_charge_event' | 'invalid_object' | 'no_rates_returned' | 'freight_connection_inactive' | 'freight_provider_id_required' | 'freight_shipment_not_found' | 'freight_tracking_not_available' | 'freight_tracking_not_found' | 'freight_shipment_not_batchable', required — The error code specified for the failed API Call
    - `message` string, required — An error message associated with the failed API call
    - `field_name` string — The name of the field that caused the error (only present for validation errors)
    - `field_value` string — The invalid value that was provided for the field (only present for validation errors)

## Other responses

- `207` — The request was a partial success. It contains results, as well as errors.
- `400` — The request contained errors.
- `404` — The specified resource does not exist.
- `500` — The request was successful.

---

[API](https://skmtc.net/shipstation/apis/shipstation-api-v2.md) · [All operations](https://skmtc.net/shipstation/apis/shipstation-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shipstation/shipstation-api-v2/revisions/d3d8c21cd227/schema)