List Regions
GET
/store/:storeCode/regionsRetrieve a paginated list of regions.
Path Parameters
storeCoderequiredstringStore slug in the URL (first argument to every SDK store method).
Query Parameters
limitnumberMaximum number of items to return.
offsetnumberNumber of items to skip before collecting the result set.
orderstringField to sort by. Prefix with `-` for descending order (e.g. `-created_at`).
fieldsstringComma-separated fields to include. Prefix with `*` to expand a relation (e.g. `id,*variants`).
qstringSearch query.
idstring | string[]Filter by ID(s).
namestringFilter by name.
currency_codestringFilter by currency code.
Response
Status
200OK
Schema
CopyHttpTypes.StoreRegionListResponse
Properties
regionsrequiredStoreRegion[]List of regions.
countrequirednumberTotal count.
offsetrequirednumberOffset applied.
limitrequirednumberLimit applied.