Locations API
Auto-generated from the OpenAPI spec. Run
node docs-site/scripts/fetch-openapi.jsto regenerate.
GET /api/v1/locations
List Locations
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
include_inactive | query | No | boolean | |
search | query | No | ||
page | query | No | integer | |
page_size | query | No | integer |
Responses
- 200 — Successful Response
- 422 — Validation Error
POST /api/v1/locations
Create Location
Request body
| Field | Required | Type | Description |
|---|---|---|---|
name | Yes | string | |
address | No | string | |
phone | No | string |
Responses
- 201 — Successful Response
- 422 — Validation Error
PUT /api/v1/locations/{location_id}
Update Location
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
location_id | path | Yes | integer |
Request body
| Field | Required | Type | Description |
|---|---|---|---|
name | No | string | |
address | No | string | |
phone | No | string | |
is_active | No | boolean |
Responses
- 200 — Successful Response
- 422 — Validation Error
DELETE /api/v1/locations/{location_id}
Deactivate Location
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
location_id | path | Yes | integer |
Responses
- 204 — Successful Response
- 422 — Validation Error
DELETE /api/v1/locations/{location_id}/remove
Remove Location
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
location_id | path | Yes | integer |
Responses
- 204 — Successful Response
- 422 — Validation Error