Get Countries

get

https://api.proshipping.net/v4/countries

Retrieves a list of countries available on the system along with their relevant details.
With this endpoint, you can search for specific countries, paginate results, and sort the data as needed.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

searchTerm

string

A string representing the term or keywords used to filter the list of countries,
helping users to narrow down the list based on the their input.

pageSize

int32

1 to 2147483647

Defaults to 100

An integer that defines the maximum number of countries (records) returned per page in the response.
For instance, if pageSize is set to 20, the API will return up to 20 countries in each response.

Note: By default, this value is set to 100.

pageNumber

int32

1 to 2147483647

Defaults to 1

An integer indicating the specific page of results to retrieve, allowing for pagination of larger datasets.
For example, if pageNumber is set to 3, the API will return the results corresponding to the third page of countries based on the specified pageSize.

Note: By default, this value is set to 1.

sortBy

string

enum

A string specifying the field by which to organise the search results.
For instance, "CountryName" could be used to sort countries alphabetically, arranging the results in a more user-friendly order.

Note: By default, this value is set to CountryName.

Enum [CountryName, Alpha2Code, Alpha3Code, Numeric, CountryGroup, PostCodeRequired, StateCodeRequired, DefaultCurrency]

sortDir

string

enum

A string indicating the direction in which to sort the results, typically set to "ascending" or "descending."
For example, setting sortDir to "Ascending" while using "CountryName" as sortBy would arrange the countries from A to Z.

Note: By default, this value is set to Ascending.

Enum [Ascending, Descending]

Allowed:

Responses

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language

Credentials

OAuth2

Loading…

Response

Choose an example:

application/json

200Returns a list of countries.

400Invalid request response.