Схеми на данните: Складове и складови места

Схеми на данните: Складове и складови места. Полета, типове и ограничения на данните, приемани или връщани от API.

Схеми на данните

Списък · Местоположения — Складове и складови места — Отговор

ApiResponse_list_LocationData__ · Полета, типове и ограничения на данните, приемани или връщани от API.

dataМасив <LocationData > Задължително: Примерен отговор · ApiResponse_list_LocationData__.

Пример: [{"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 Задължително: Метаданни на отговора.

Пример: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Допълнителни полета: Не

Списък — Складове и складови места — Отговор

ApiResponse_list_WarehouseData__ · Полета, типове и ограничения на данните, приемани или връщани от API.

dataМасив <WarehouseData > Задължително: Примерен отговор · ApiResponse_list_WarehouseData__.

Пример: [{"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 Задължително: Метаданни на отговора.

Пример: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Допълнителни полета: Не

Получаване — Складове и складови места — Отговор

ApiResponse_WarehouseData_ · Полета, типове и ограничения на данните, приемани или връщани от API.

dataWarehouseData Задължително: Примерен отговор · WarehouseData.

Пример: {"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 Задължително: Метаданни на отговора.

Пример: {"request_id":"example"}

Допълнителни полета: Не

Списък · Местоположения — Складове и складови места — Отговор

LocationData · Полета, типове и ограничения на данните, приемани или връщани от API.

codeНизЗадължително

Устойчив машинночетим код.

Пример: "example"

created_atНизЗадължително

Време на създаване.

format: "date-time"

Пример: "2026-01-01T12:00:00Z"

idНизЗадължително

Идентификатор на ресурса; запазете го във върнатия вид. (LocationData).

Пример: "example"

is_leafБулева стойностЗадължително

Дали категорията няма подкатегории.

Пример: true

location_typeНизЗадължително

Тип на складовото място.

Ограничения

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

Пример: "zone"

nameНизЗадължително

Име на ресурса в съответния контекст.

Пример: "Example"

parent_idНиз nullЗадължително

Идентификатор на родителската категория.

Пример: null

updated_atНизЗадължително

Време на последната актуализация.

format: "date-time"

Пример: "2026-01-01T12:00:00Z"

versionЦяло числоЗадължително

Версия на ресурса за контрол на едновременни записи.

Пример: 1

warehouse_idНизЗадължително

Идентификатор на склада.

Пример: "example"

Допълнителни полета: Не

Складови места

LocationQuantity · Схема · Схеми на данните: Складове и складови места

location_idНизЗадължително

Идентификатор на складовото място.

Ограничения

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

Пример: "example"

on_handЦяло числоЗадължително

Физическо складово количество.

minimum: 0maximum: 2147483647

Пример: 1

Допълнителни полета: Не

Получаване — Складове и складови места — Отговор

WarehouseData · Полета, типове и ограничения на данните, приемани или връщани от API.

activeБулева стойностЗадължително: Дали ресурсът е активен.

Пример: true
address_lineНиз nullЗадължително: Ред от адреса.

Пример: "example"
cityНиз nullЗадължително: Град или населено място.

Пример: "example"
codeНизЗадължително: Устойчив машинночетим код.

Пример: "example"
country_codeНизЗадължително: Код на държавата.

Пример: "PL"
created_atНизЗадължително: Време на създаване.

format: "date-time"

Пример: "2026-01-01T12:00:00Z"
customer_visibleБулева стойностЗадължително: Дали статусът е видим за клиента.

Пример: false
idНизЗадължително: Идентификатор на ресурса; запазете го във върнатия вид. (WarehouseData).

Пример: "example"
nameНизЗадължително: Име на ресурса в съответния контекст.

Пример: "Example"
postal_codeНиз nullЗадължително: Пощенски код.

Пример: "example"
updated_atНизЗадължително: Време на последната актуализация.

format: "date-time"

Пример: "2026-01-01T12:00:00Z"
versionЦяло числоЗадължително: Версия на ресурса за контрол на едновременни записи.

Пример: 1

Допълнителни полета: Не