Error
A valid request URL is required to generate request examples{
"id": "reg-idf",
"name": "Île-de-France",
"code": "IDF",
"storeCount": 3,
"active": true
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123,
"fieldErrors": [
{
"field": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}Network
Get a region by id
Resolves one region from the id you took out of the region listing, when you already hold the id and only need its name, code or storeCount — otherwise list and filter, which is one call instead of two. Reach for it to confirm a region exists and read its current fields before a maintenance write (create / update / deactivate all address a region by this id). 404s when no region carries the given id.
GET
/
v1
/
regions
/
{regionId}
Error
A valid request URL is required to generate request examples{
"id": "reg-idf",
"name": "Île-de-France",
"code": "IDF",
"storeCount": 3,
"active": true
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123,
"fieldErrors": [
{
"field": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}Authorizations
Authorization: Bearer <token>. Accepts EITHER a Keycloak access token (scopes-in-token) OR an opaque POS session token; both resolve to the same pos.* scope vocabulary the route guards enforce.
Path Parameters
Minimum string length:
1