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 Description
carrier Required. Carrier. Valid value(s): usps
originCountryCode Required. The two-character ISO country code for the origin country. Valid value(s): US

Request Header

Name Description
Authorization Required. OAuth token generated using the Generate an OAuth Token API.
Recommended. Set this to true to use the standard error object if an error occurs.

Response Elements

The operation returns an array of country objects. 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>" \
-H "X-PB-UnifiedErrorStructure: true"

Sample Response

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

Error Codes

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