Store API

Manage warehouses — retrieve, create, update and delete

Base URL

https://{tenant}.logzi.com/api/store/

Every request returns a JSON response. On success result.code == 1, on error result.code == 0.

GET /api/store/get

Retrieve a single warehouse by its identifier, with full details.

Query parameters

ParameterTypeRequiredDescription
idintUnique identifier of the warehouse
store_defaultint1 = retrieve the default warehouse

Example request

GET /api/store/get?id=1
X-API-KEY: {your_api_key}
GET /api/store/list

Retrieve a paginated list of warehouses, with filtering options.

Query parameters

ParameterTypeRequiredDescription
list_offsetintPagination offset (default: 0)
list_countintNumber of records per page
list_condition[name]stringFilter by warehouse name (LIKE)
language_idintLanguage identifier

Example request

GET /api/store/list?list_offset=0&list_condition[name]=F%C5%91rakt%C3%A1r
X-API-KEY: {your_api_key}
POST /api/store/save

Create or update a warehouse. For a new record use data[id] = 0.

POST fields — data object

FieldTypeRequiredDescription
idint0 = new warehouse, >0 = update
company_idintCompany identifier
company_user_idintResponsible employee ID
namestringWarehouse name
country_idintCountry identifier
zipstringZIP code
citystringCity
addressstringStreet, house number

Example request

POST /api/store/save
X-API-KEY: {your_api_key}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "company_id": 1,
    "company_user_id": 3,
    "name": "Főraktár"
  }
}
POST /api/store/delete

Delete a warehouse by its identifier.

POST fields — data object

FieldTypeRequiredDescription
idintIdentifier of the warehouse to delete

Example request

POST /api/store/delete
X-API-KEY: {your_api_key}
Content-Type: application/json

{ "data": { "id": 1 } }

Get in touch with us

Interested in our software? Feel free to write to us!

Need help?

If you can't find the answer and need assistance

Create your account now,
pay later!

Try it free for 3 days, no risk, no obligation!