carriers

Get carrier by code

Retrieves the shipping carrier account details for the specified carrierCode. Use this method to determine a carrier's account balance.

get/carriers/getcarrier

Request

  • Base URL: https://ssapi.shipstation.com
  • URL: https://ssapi.shipstation.com/carriers/getcarrier
  • Auth: HTTP basic

Query parameters

carrierCodestring required

The code for the carrier account to retrieve

Response

Carrier retrieved successfully

namestring
codestring
accountNumberstring
requiresFundedAccountboolean
balancenumber
nicknamestring nullable
shippingProviderIdinteger
primaryboolean

Example response

{
  "name": "Stamps.com",
  "code": "stamps_com",
  "accountNumber": "SS123",
  "requiresFundedAccount": true,
  "balance": 24.27,
  "shippingProviderId": 12345,
  "primary": true
}

Changes

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