carriers

Get carrier by ID

Changed on
<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>

Retrive details about a specific carrier by its carrier ID.

get/v2/carriers/{carrier_id}

Request

  • Base URL
    https://api.shipstation.com
  • URL
    https://api.shipstation.com/v2/carriers/{carrier_id}
  • Auth
    API key in header api-key

Response

The request was a success.

carrier_idstring

A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.

carrier_codestring

A [shipping carrier] , such as fedex, dhl_express, stamps_com, etc.

account_numberstring

The account number that the carrier is connected to.

connection_status'pending_approval' | 'approved' nullable

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_amountboolean

Indicates whether the carrier requires funding to use its services

balancenumber

Current available balance

nicknamestring

Nickname given to the account when initially setting up the carrier.

friendly_namestring

Screen readable name

funding_source_idstring

A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.

primaryboolean

Is this the primary carrier that is used by default when no carrier is specified in label/shipment creation

has_multi_package_supporting_servicesboolean

Carrier supports multiple packages per shipment

supports_label_messagesboolean

The carrier supports adding custom label messages to an order.

disabled_by_billing_planboolean

The carrier is disabled by the current ShipStation account's billing plan.

send_ratesboolean

The carrier provides rates for the shipment.

supports_user_managed_ratesboolean

The carrier supports user-managed rates for shipments.

Example response

{
  "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
}

Changes

  • 4e29670aa28dRevision changes
    • warning

      added the new bring_your_own_label_not_supported enum value to the // response property for the response status

    • warning

      added the new bring_your_own_label_not_supported enum value to the // response property for the response status

    • warning

      added the new multiple_sales_orders enum value to the // response property for the response status

    • warning

      added the new multiple_sales_orders enum value to the // response property for the response status

    • warning

      added the new sales_order_link_required enum value to the // response property for the response status

    • warning

      added the new sales_order_link_required enum value to the // response property for the response status

  • bf3618aaf7e1Revision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      added subschema #2 to the / response property oneOf list for the response status

    • info

      removed from the / response property allOf list for the response status