Схеми даних: Склади й місця зберігання

Схеми даних: Склади й місця зберігання. Поля, типи й обмеження даних, які 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

Додаткові поля: Ні