Countries List

HTTP Request

GET /v1/countries?carrier={carrier}&originCountryCode={two-character-ISO-code}


This operation returns a list of supported destination countries to which the carrier offers international shipping services.

Request URIs


Query Parameters

Name Data Type Description
carrier String Required. Carrier. Valid value(s): usps
originCountryCode String Required. The two-character ISO country code of origin. Valid value(s): US

Request Header

Name Data Type Description
Authorization String Required. OAuth token generated using the Generate an OAuth Token API.

Response Elements

An array of country objects is returned. A country object contains the following fields:

Name Data Type Description
countryCode String The two-character ISO country code.
countryName String Country name.

Sample Request

curl -X GET .../v1/countries?originCountryCode=US&carrier=usps \
-H "Authorization: Bearer <oauth_token>"

Sample Response

[ {
    "countryCode": "AC",
    "countryName": "Ascension"
}, ... ]

Error Codes

For a list of all PB Shipping APIs error codes, see Error Codes.