Warehouse and location models

Models for warehouses and their locations. Check identifiers, address fields and the data returned by list and detail operations.

Data schemas

List warehouse locations — Response

ApiResponse_list_LocationData__ · Fields, types and constraints of data accepted or returned by the API.

dataArray <LocationData > Required: Response example · ApiResponse_list_LocationData__.

Example: [{"code":"example","created_at":"2026-01-01T12:00:00Z","id":"example","is_leaf":true,"location_type":"zone","name":"Example","parent_id":null,"updated_at":"2026-01-01T12:00:00Z","version":1,"warehouse_id":"example"}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Required: Response metadata.

Example: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Additional fields: No

List warehouses — Response

ApiResponse_list_WarehouseData__ · Fields, types and constraints of data accepted or returned by the API.

dataArray <WarehouseData > Required: Response example · ApiResponse_list_WarehouseData__.

Example: [{"active":true,"address_line":"example","city":"example","code":"example","country_code":"PL","created_at":"2026-01-01T12:00:00Z","customer_visible":false,"id":"example","name":"Example","postal_code":"example","updated_at":"2026-01-01T12:00:00Z","version":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Required: Response metadata.

Example: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Additional fields: No

Get a warehouse — Response

ApiResponse_WarehouseData_ · Fields, types and constraints of data accepted or returned by the API.

dataWarehouseData Required: Response example · WarehouseData.

Example: {"active":true,"address_line":"example","city":"example","code":"example","country_code":"PL","created_at":"2026-01-01T12:00:00Z","customer_visible":false,"id":"example","name":"Example","postal_code":"example","updated_at":"2026-01-01T12:00:00Z","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Required: Response metadata.

Example: {"request_id":"example"}

Additional fields: No

List warehouse locations — Response

LocationData · Fields, types and constraints of data accepted or returned by the API.

codeStringRequired

Stable machine-readable code.

Example: "example"

created_atStringRequired

Creation time.

format: "date-time"

Example: "2026-01-01T12:00:00Z"

idStringRequired

Resource identifier; preserve it as returned. (LocationData).

Example: "example"

is_leafBooleanRequired

Whether the category has no child categories.

Example: true

location_typeStringRequired

Warehouse location type.

Constraints

enum: ["zone", "rack", "shelf", "bin"]

Example: "zone"

nameStringRequired

Resource name in the relevant context.

Example: "Example"

parent_idString nullRequired

Parent category identifier.

Example: null

updated_atStringRequired

Most recent update time.

format: "date-time"

Example: "2026-01-01T12:00:00Z"

versionIntegerRequired

Resource version used for concurrency control.

Example: 1

warehouse_idStringRequired

Warehouse identifier.

Example: "example"

Additional fields: No

Warehouse locations

LocationQuantity · Schema · Warehouse and location models

location_idStringRequired

Warehouse location identifier.

Constraints

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

Example: "example"

on_handIntegerRequired

Physical stock quantity.

minimum: 0maximum: 2147483647

Example: 1

Additional fields: No

Get a warehouse — Response

WarehouseData · Fields, types and constraints of data accepted or returned by the API.

activeBooleanRequired: Whether the resource is active.

Example: true
address_lineString nullRequired: Address line.

Example: "example"
cityString nullRequired: City or locality.

Example: "example"
codeStringRequired: Stable machine-readable code.

Example: "example"
country_codeStringRequired: Country code.

Example: "PL"
created_atStringRequired: Creation time.

format: "date-time"

Example: "2026-01-01T12:00:00Z"
customer_visibleBooleanRequired: Whether the status is visible to the customer.

Example: false
idStringRequired: Resource identifier; preserve it as returned. (WarehouseData).

Example: "example"
nameStringRequired: Resource name in the relevant context.

Example: "Example"
postal_codeString nullRequired: Postal code.

Example: "example"
updated_atStringRequired: Most recent update time.

format: "date-time"

Example: "2026-01-01T12:00:00Z"
versionIntegerRequired: Resource version used for concurrency control.

Example: 1

Additional fields: No