List Regions

GET/store/regions

Retrieve a list of regions. The regions can be filtered by fields such as created_at. The regions can also be paginated. This API Route is useful to show the customer all available regions to choose from.

Request

Query Params

offset

integer

optional

The number of regions to skip when retrieving the regions.

limit

integer

optional

Limit the number of regions returned.

array[string]

optional

filter by dates less than this date

Example:

["",""]

array[string]

optional

filter by dates greater than this date

Example:

["",""]

lte

array[string]

optional

filter by dates less than or equal to this date

Example:

["",""]

gte

array[string]

optional

filter by dates greater than or equal to this date

Example:

["",""]

Request samples

Responses

OK(200)

Client Error or Multiple Errors(400)

Not Found Error(404)

Invalid State Error(409)

Invalid Request Error(422)

Server Error(500)

HTTP Code: 200

Content Type : JSONapplication/json

No schema defined

Not configured

Last modified: a year ago