A valid request URL is required to generate request examples{
"id": "reg-bre",
"name": "Bretagne",
"code": "BRE",
"storeCount": 0,
"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
}
}Create a region
Adds a geographic region to the network directory. This is a back-office MAINTENANCE operation: the created region immediately becomes a selectable grouping stores can be assigned to. The id is caller-supplied — pick a stable, URL-safe slug (e.g. reg-bre), because it is the handle every other maintenance verb addresses it by; 409s when a region already carries it (a create never overwrites — use the update operation instead). active is optional and defaults to true; storeCount is optional and defaults to 0 (a fresh region holds no stores until one is assigned to it — it is a stored counter, not a live join).
A valid request URL is required to generate request examples{
"id": "reg-bre",
"name": "Bretagne",
"code": "BRE",
"storeCount": 0,
"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.
Body
Response
The created region, exactly as the directory now serves it.