latestOpenAPI 3.1.0MIT2026-08-104712182.1 KB

c71c20d26559

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

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
}