Перейти до вмісту
ShopentlyLearn

Схеми даних: Постачання

Схеми даних: Постачання. Поля, типи й обмеження даних, які API приймає або повертає.

Схеми даних

Отримати — Постачання — Відповідь

ApiResponse_DeliveryDetailData_ · Поля, типи й обмеження даних, які API приймає або повертає.
dataDeliveryDetailData Обов’язкове

Приклад відповіді · DeliveryDetailData.

Приклад: {"created_at":"2026-01-01T12:00:00Z","deleted_at":null,"delivered_at":"2026-01-01T12:00:00Z","id":"example","increases_stock":true,"location_id":"example","notes":"example","quantity":1,"received_at":null,"record_status":"active","status":"planned","stock_applied_at":null,"target_id":"example","target_type":"product","updated_at":"2026-01-01T12:00:00Z","version":1,"warehouse_id":"example"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Обов’язкове

Метадані відповіді.

Приклад: {"request_id":"example"}

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

Отримати список — Постачання — Відповідь

ApiResponse_list_DeliveryData__ · Поля, типи й обмеження даних, які API приймає або повертає.
dataМасив <DeliveryData > Обов’язкове

Приклад відповіді · ApiResponse_list_DeliveryData__.

Приклад: [{"created_at":"2026-01-01T12:00:00Z","deleted_at":null,"delivered_at":"2026-01-01T12:00:00Z","id":"example","increases_stock":true,"location_id":"example","quantity":1,"received_at":null,"record_status":"active","status":"planned","stock_applied_at":null,"target_id":"example","target_type":"product","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"}

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

Створити — Постачання — Тіло запиту

DeliveryCreate · Поля, типи й обмеження даних, які API приймає або повертає.
delivered_atРядокОбов’язкове

Дата й час доставки.

format: "date-time"
Приклад: "2026-01-01T00:00:00Z"
increases_stockЛогічне значенняНеобов’язкове

Чи збільшує отримання постачання складський залишок.

За замовчуванням: true
location_idРядокОбов’язкове

Ідентифікатор місця зберігання на складі.

Обмеження
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Приклад: "example"
notesРядокНеобов’язкове

Додаткові примітки.

maxLength: 2000
За замовчуванням: ""
quantityЦіле числоОбов’язкове

Кількість одиниць.

minimum: 1maximum: 2147483647
Приклад: 1
reasonРядокНеобов’язкове

Записана причина зміни.

maxLength: 500
За замовчуванням: ""
statusРядокОбов’язкове

Статус, допустимий для цієї конкретної операції.

Обмеження
enum
["planned", "received"]
Приклад: "planned"
target_idРядокОбов’язкове

Ідентифікатор товару або варіанта, якого стосується операція.

Обмеження
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Приклад: "example"
target_typeРядокОбов’язкове

Чи стосується операція товару або варіанта.

Обмеження
enum
["product", "variant"]
Приклад: "product"
warehouse_idРядокОбов’язкове

Ідентифікатор складу.

Обмеження
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Приклад: "example"

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

Отримати список — Постачання — Відповідь

DeliveryData · Поля, типи й обмеження даних, які API приймає або повертає.
created_atРядокОбов’язкове

Час створення.

format: "date-time"
Приклад: "2026-01-01T12:00:00Z"
deleted_atРядок nullОбов’язкове

Час видалення, якщо він є.

Рядок:format: "date-time"
Приклад: null
delivered_atРядокОбов’язкове

Дата й час доставки.

format: "date-time"
Приклад: "2026-01-01T12:00:00Z"
idРядокОбов’язкове

Ідентифікатор ресурсу; зберігайте його в отриманому вигляді. (DeliveryData).

Приклад: "example"
increases_stockЛогічне значенняОбов’язкове

Чи збільшує отримання постачання складський залишок.

Приклад: true
location_idРядокОбов’язкове

Ідентифікатор місця зберігання на складі.

Приклад: "example"
quantityЦіле числоОбов’язкове

Кількість одиниць.

Приклад: 1
received_atРядок nullОбов’язкове

Дата й час отримання постачання.

Рядок:format: "date-time"
Приклад: null
record_statusРядокОбов’язкове

Збережений статус запису.

Обмеження
enum
["active", "deleted"]
Приклад: "active"
statusРядокОбов’язкове

Статус, допустимий для цієї конкретної операції.

Обмеження
enum
["planned", "received"]
Приклад: "planned"
stock_applied_atРядок nullОбов’язкове

Дата й час застосування зміни залишку за постачанням.

Рядок:format: "date-time"
Приклад: null
target_idРядокОбов’язкове

Ідентифікатор товару або варіанта, якого стосується операція.

Приклад: "example"
target_typeРядокОбов’язкове

Чи стосується операція товару або варіанта.

Обмеження
enum
["product", "variant"]
Приклад: "product"
updated_atРядок nullОбов’язкове

Час останнього оновлення.

Рядок:format: "date-time"
Приклад: "2026-01-01T12:00:00Z"
versionЦіле числоОбов’язкове

Версія ресурсу для контролю одночасних змін.

Приклад: 1
warehouse_idРядокОбов’язкове

Ідентифікатор складу.

Приклад: "example"

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

Отримати — Постачання — Відповідь

DeliveryDetailData · Поля, типи й обмеження даних, які API приймає або повертає.
created_atРядокОбов’язкове

Час створення.

format: "date-time"
Приклад: "2026-01-01T12:00:00Z"
deleted_atРядок nullОбов’язкове

Час видалення, якщо він є.

Рядок:format: "date-time"
Приклад: null
delivered_atРядокОбов’язкове

Дата й час доставки.

format: "date-time"
Приклад: "2026-01-01T12:00:00Z"
idРядокОбов’язкове

Ідентифікатор ресурсу; зберігайте його в отриманому вигляді. (DeliveryDetailData).

Приклад: "example"
increases_stockЛогічне значенняОбов’язкове

Чи збільшує отримання постачання складський залишок.

Приклад: true
location_idРядокОбов’язкове

Ідентифікатор місця зберігання на складі.

Приклад: "example"
notesРядок nullОбов’язкове

Додаткові примітки.

Приклад: "example"
quantityЦіле числоОбов’язкове

Кількість одиниць.

Приклад: 1
received_atРядок nullОбов’язкове

Дата й час отримання постачання.

Рядок:format: "date-time"
Приклад: null
record_statusРядокОбов’язкове

Збережений статус запису.

Обмеження
enum
["active", "deleted"]
Приклад: "active"
statusРядокОбов’язкове

Статус, допустимий для цієї конкретної операції.

Обмеження
enum
["planned", "received"]
Приклад: "planned"
stock_applied_atРядок nullОбов’язкове

Дата й час застосування зміни залишку за постачанням.

Рядок:format: "date-time"
Приклад: null
target_idРядокОбов’язкове

Ідентифікатор товару або варіанта, якого стосується операція.

Приклад: "example"
target_typeРядокОбов’язкове

Чи стосується операція товару або варіанта.

Обмеження
enum
["product", "variant"]
Приклад: "product"
updated_atРядок nullОбов’язкове

Час останнього оновлення.

Рядок:format: "date-time"
Приклад: "2026-01-01T12:00:00Z"
versionЦіле числоОбов’язкове

Версія ресурсу для контролю одночасних змін.

Приклад: 1
warehouse_idРядокОбов’язкове

Ідентифікатор складу.

Приклад: "example"

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