carriers

Get carrier by id

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.

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",
  "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
    }
  ],
  "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

No recorded changes to this operation across all 1 revision of this API.