Ucommerce includes full API reference documentation and lots of helpful articles to help you build your e-commerce site as effortlessly as possible.

Topics Payment Providers

Get countries

This article will guide you through how to retrieve countries. The Postman collection will be used for all examples. You need a valid countryId to be able to add a Shipping Address, Billing Address and a Payment Method to a basket.


Optional query parameters

  • filterOnStore - limits the list of countries to ones with shipping or payment methods available for the given store (based on accessToken).
  • maxItems - limits the number of payment methods returned. The list is paginated.
  • nextPagingToken - required to fetch the next page. The token is described in detail in Next Paging Token article.

Get countries

Open the Get Countries request.

Optional query parameters can be added.


    curl -D- -X POST {base_url}/api/v1/countries?filterOnStore=false&maxItems={maxItems}&nextPagingToken={nextPagingToken} \
    -H 'Authorization: Bearer <ACCESS_TOKEN>'
    -H 'Content-Type: application/json' \


        "countries": [
                "cultureCode": "{cultureCode}",
                "id": "{countryId}",
                "name": "{countryName}"
        "nextPagingToken": "{nextPagingToken | null}"

Possible Errors that may occur:

Error Description
Unauthorized (401) The token is expired.
Forbidden (403) The token does not have access to this endpoint.

See Handling failures for more info.