Преминете към съдържанието
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"

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