---
title: "Get Carrier"
method: GET
path: "/api/v1/carrierAccounts/{carrierAccountID}"
tags: ["Carrier Accounts"]
---

# Get Carrier

`GET /api/v1/carrierAccounts/{carrierAccountID}`

## Request

- Base URL: `https://api-sandbox.sendpro360.pitneybowes.com/carrieraccountmgmt`
- URL: `https://api-sandbox.sendpro360.pitneybowes.com/carrieraccountmgmt/api/v1/carrierAccounts/{carrierAccountID}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/pitneybowes/apis/carrier-onbording-apis/docs/api/v1/carrierAccounts/:carrierAccountID/get.ts> (a function with typed inputs; its response is checked against the schema)

Get Carrier Account details API

## Path parameters

- `carrierAccountID` string, required

## Headers

- `X-PB-Developer-Partner-ID` string

## Response `200`

Carrier Added Successfully

- GetCarrierAccountResponse
  - `carrierAccountID` string: Unique identifier of carrier account created
  - `accountNumber` string: Unique identifier of the account
  - `carrierID` 'FEDEX' | 'UPS' | 'DHLEXP': It defines the carrier ID, can be get from `Get Carriers API`
  - `description` string: It defines the carrier account name
  - `carrierAccountType` string: This defines carrier account type
  - `provisioningType` string: It defines the provisioning method
  - `parameters` object: It lists the additional details required adding carrier account
    - `username` string: Username for the account, required for DHL Express
    - `accountAddress` object: It includes the account address details
      - `addressLine1` string: The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).
      - `city` string: The name of the city or town to where the address belongs.
      - `state` string: The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code.
      - `postalCode` string: The postal code or ZIP code of the address. For US addresses, use either the 5-digit or 9-digit ZIP code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.
      - `countryCode` string: This indicates the two-character ISO code of the source country from the ISO country list.
      - `email` string: The email address of the sender. It can be person's email address or company email address (for non-residential).
      - `company` string: This indicates the name of the company, in case if address is not residential.
      - `name` string: Name of the sender to which this address points.
      - `phone` string: This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum characters for Phone number is 10 digits.
    - `contactAddress` object: It includes the contact address details
      - `addressLine1` string: The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).
      - `city` string: The name of the city or town to where the address belongs.
      - `state` string: The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code.
      - `postalCode` string: The postal code or ZIP code of the address. For US addresses, use either the 5-digit or 9-digit ZIP code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.
      - `countryCode` string: This indicates the two-character ISO code of the source country from the ISO country list.
      - `email` string: The email address of the sender. It can be person's email address or company email address (for non-residential).
      - `company` string: This indicates the name of the company, in case if address is not residential.
      - `name` string: Name of the sender to which this address points.
      - `phone` string: This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum characters for Phone number is 10 digits.
    - `hubID` string: It defines FedEx Smartpost hub ID, required only for FedEx Smartpost account
    - `invoiceAmount` string: It defines the invoice amount ,Only for UPS acccount
    - `invoiceControlID` string: It defines the invoice controlID ,Only for UPS acccount
    - `invoiceDate` string: It defines the date of the invoice in the format YYYYMMDD., Only for UPS account
    - `invoiceNumber` string: It defines the invoice number ,Only for UPS acccount

## Other responses

- `400`: Invalid request.
- `401`: The request could not be authorized.

---

[API](https://skmtc.dev/pitneybowes/apis/carrier-onbording-apis.md) - [All operations](https://skmtc.dev/pitneybowes/apis/carrier-onbording-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/pitneybowes/apis/carrier-onbording-apis/revisions/7176b074cba2?raw)