Skip to main content

get regions

POST 
/stock/region/v1/getregions

Searches/loads active regions. The request body is optional but its content matters: a null body returns an empty list, while a non-null body WITHOUT any filter (e.g. {}) returns ALL active regions the caller may see (no paging/limit). Filters are evaluated in a FIXED priority order and the FIRST non-empty one wins: (1) identifiers[].regionSid, (2) regionTypeSids, (3) isCountry, (4) zipCodes, (5) isUsedInTaxCode. A role-based visibility filter (ROLE_REGION_REGIONS_GET_API) is always applied on top. Region SIDs must be resolved beforehand (e.g. via an unfiltered call or by regionType/zipCode), never invented.

Request​

Responses​

successful operation