carriers

Get carrier by ID

Changed on

Retrive carrier info by ID

get/v1/carriers/{carrier_id}

Request

  • Base URL: https://api.shipengine.com
  • URL: https://api.shipengine.com/v1/carriers/{carrier_id}
  • Auth: API key in header API-Key

Response

The request was a success.

carrier_idstring

A string that uniquely identifies a ShipEngine 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 ShipEngine 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

allows_returnsboolean

The carrier has services that support return shipments.

supports_label_messagesboolean

The carrier supports adding custom label messages to an order.

disabled_by_billing_planboolean

The carrier is disabled by the current ShipEngine 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.

connection_status'pending_approval' | 'approved'

The current connection status of the carrier. Indicates whether the carrier connection is pending approval or has been approved for use.

Example response

{
  "carrier_id": "se-28529731",
  "carrier_code": "dhl_express",
  "account_number": "account_570827",
  "balance": 3799.52,
  "nickname": "ShipEngine Account - Stamps.com",
  "friendly_name": "Stamps.com",
  "funding_source_id": "se-28529731",
  "services": [
    {
      "carrier_id": "se-28529731",
      "carrier_code": "se-28529731",
      "service_code": "usps_media_mail",
      "name": "USPS First Class Mail",
      "send_rates": true
    }
  ],
  "packages": [
    {
      "package_id": "se-28529731",
      "package_code": "package",
      "name": "laptop_box",
      "description": "Packaging for laptops"
    }
  ],
  "options": [
    {
      "name": "contains_alcohol",
      "default_value": "false"
    }
  ],
  "send_rates": true
}

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

    • warning

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

    • breaking

      the //// response's property type changed from no type to string for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

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

    • info

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

    • info

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

    • info

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

    • info

      the //// response's property pattern ^se(-[a-z0-9]+)+$ was added for the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status