Base URL
https://{tenant}.logzi.com/api/store_locality/
Every request returns a JSON response. On success result.code == 1, on error result.code == 0. A shelf location is a physical storage position within a warehouse, identified by column, row, and floor coordinates.
/api/store_locality/get
Retrieve a single shelf location by identifier.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int | Shelf location unique identifier |
Example request
GET /api/store_locality/get?id=3
X-API-KEY: {your_api_key}/api/store_locality/list
Retrieve a paginated list of shelf locations with filtering options.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
list_offset | int | Pagination offset (default: 0) | |
list_condition[store_id] | int | Filter by warehouse identifier | |
list_condition[barcode] | string | Filter by barcode (LIKE) | |
list_condition[name] | string | Filter by name (LIKE) |
Example request
GET /api/store_locality/list?list_condition[store_id]=1&list_offset=0
X-API-KEY: {your_api_key}/api/store_locality/save
Create or modify a shelf location. For a new shelf location use data[id] = 0.
POST fields — data object
| Field | Type | Required | Description |
|---|---|---|---|
id | int | 0 = new shelf location, >0 = update | |
store_id | int | Warehouse identifier | |
name | string | Shelf location name / label | |
company_id | int | Company identifier | |
company_user_id | int | Identifier of the creating staff member | |
barcode | string | Barcode on the shelf location | |
locality_col | string | Column identifier (e.g. "A") | |
locality_row | string | Row identifier (e.g. "3") | |
locality_floor | string | Floor identifier (e.g. "2") |
Example request
POST /api/store_locality/save
X-API-KEY: {your_api_key}
Content-Type: application/json
{
"data": {
"id": 0,
"store_id": 1,
"name": "A-3-2",
"locality_col": "A",
"locality_row": "3",
"locality_floor": "2",
"barcode": "LOC-A-3-2"
}
}/api/store_locality/delete
Delete a shelf location by identifier.
POST fields — data object
| Field | Type | Required | Description |
|---|---|---|---|
id | int | Identifier of the shelf location to delete |
Example request
POST /api/store_locality/delete
X-API-KEY: {your_api_key}
Content-Type: application/json
{ "data": { "id": 3 } }/api/store_locality/download
Download the shelf location barcode in a printable format.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int | Shelf location identifier |
Example request
GET /api/store_locality/download?id=3
X-API-KEY: {your_api_key}Create your account now,
pay later!
