Config | Flow Retail Docs

List countries

get

List all countries.

Authorizations

Query parameters

pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional

ENUM	Description
ASC	Sort in ascending order
DESC	Sort in descending order

Possible values:

Responses

200

Example response

application/json

get

GET /v2/countries HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "code": "text",
      "countryUid": "text",
      "createdAt": "2025-07-30T18:14:22.001Z",
      "currency": "text",
      "lastModifiedAt": "2025-07-30T18:14:22.001Z",
      "name": "text",
      "phonePrefix": "text",
      "languageCode": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Get country details

get

Get details for a country

Authorizations

Path parameters

countryUidstringRequired

Reference to a Country.

Pattern: ^[A-Za-z0-9-_]+

Responses

200

Example response

application/json

get

GET /v2/countries/{countryUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "code": "text",
  "countryUid": "text",
  "createdAt": "2025-07-30T18:14:22.001Z",
  "currency": "text",
  "lastModifiedAt": "2025-07-30T18:14:22.001Z",
  "name": "text",
  "phonePrefix": "text",
  "languageCode": "text"
}

List VAT codes

get

Get a list of current VAT codes.

Authorizations

Query parameters

vatCountryCodestringOptional

Filter by country

pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional

ENUM	Description
ASC	Sort in ascending order
DESC	Sort in descending order

Possible values:

Responses

200

Example response

application/json

get

GET /v2/vat HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "createdAt": "2025-07-30T18:14:22.001Z",
      "fromDate": "2025-07-30T18:14:22.001Z",
      "lastModifiedAt": "2025-07-30T18:14:22.001Z",
      "name": "text",
      "rate": 1,
      "vatCodeUid": "text",
      "countryCode": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

List VAT codes for a country code

get

Get a list of current VAT codes for a specific country code.

Authorizations

Path parameters

countryCodestringRequired

countryCode

Query parameters

pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional

ENUM	Description
ASC	Sort in ascending order
DESC	Sort in descending order

Possible values:

Responses

200

Example response

application/json

get

GET /v2/countries/{countryCode}/vat HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "createdAt": "2025-07-30T18:14:22.001Z",
      "fromDate": "2025-07-30T18:14:22.001Z",
      "lastModifiedAt": "2025-07-30T18:14:22.001Z",
      "name": "text",
      "rate": 1,
      "vatCodeUid": "text",
      "countryCode": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

List locale

get

List all available locale

Responses

200

Locale response

application/json

get

GET /v2/metadata/locale HTTP/1.1
Host: api.flowretail.com
Accept: */*

200

Locale response

{
  "items": [
    {
      "locale": "text",
      "name": "text"
    }
  ]
}

List currencies

get

List all available currencies

Responses

200

List all available currencies

application/json

get

GET /v2/metadata/currencies HTTP/1.1
Host: api.flowretail.com
Accept: */*

200

List all available currencies

{
  "items": [
    {
      "currencyCode": "text",
      "name": "text",
      "denominations": {
        "coins": [
          "text"
        ],
        "notes": [
          "text"
        ]
      }
    }
  ]
}

List labels

get

List available label formats. Label sizes are in mm.

Authorizations

Responses

200

Example response

application/json

get

GET /v2/metadata/labels HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "key": "40X50_BARCODE_NAME_SKU",
      "name": "text",
      "size": "40x50"
    }
  ]
}