Aqbeż għall-kontenut
ShopentlyLearn

Skemi tad-data: Kunsinni deħlin

Skemi tad-data: Kunsinni deħlin. L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

Skemi tad-data

Ikseb — Kunsinni deħlin — Risposta

ApiResponse_DeliveryDetailData_ · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.
dataDeliveryDetailData Obbligatorju

Eżempju ta’ tweġiba · DeliveryDetailData.

Eżempju: {"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 Obbligatorju

Metadata tat-tweġiba.

Eżempju: {"request_id":"example"}

Oqsma addizzjonali: Le

Elenka — Kunsinni deħlin — Risposta

ApiResponse_list_DeliveryData__ · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.
dataArray <DeliveryData > Obbligatorju

Eżempju ta’ tweġiba · ApiResponse_list_DeliveryData__.

Eżempju: [{"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 Obbligatorju

Metadata tat-tweġiba.

Eżempju: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Oqsma addizzjonali: Le

Oħloq — Kunsinni deħlin — Kontenut tat-talba

DeliveryCreate · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.
delivered_atStringObbligatorju

Data u ħin tal-kunsinna.

format: "date-time"
Eżempju: "2026-01-01T00:00:00Z"
increases_stockBooleanMhux obbligatorju

Jekk ir-riċeviment tal-kunsinna jżidx l-istokk.

Valur predefinit: true
location_idStringObbligatorju

Identifikatur tal-post fil-maħżen.

Restrizzjonijiet
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Eżempju: "example"
notesStringMhux obbligatorju

Noti addizzjonali.

maxLength: 2000
Valur predefinit: ""
quantityNumru sħiħObbligatorju

Numru ta’ unitajiet.

minimum: 1maximum: 2147483647
Eżempju: 1
reasonStringMhux obbligatorju

Raġuni rreġistrata għall-bidla.

maxLength: 500
Valur predefinit: ""
statusStringObbligatorju

Status aċċettat minn din l-operazzjoni speċifika.

Restrizzjonijiet
enum
["planned", "received"]
Eżempju: "planned"
target_idStringObbligatorju

Identifikatur tal-prodott jew tal-varjant affettwat mill-operazzjoni.

Restrizzjonijiet
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Eżempju: "example"
target_typeStringObbligatorju

Jekk l-operazzjoni tirrigwardax prodott jew varjant.

Restrizzjonijiet
enum
["product", "variant"]
Eżempju: "product"
warehouse_idStringObbligatorju

Identifikatur tal-maħżen.

Restrizzjonijiet
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Eżempju: "example"

Oqsma addizzjonali: Le

Elenka — Kunsinni deħlin — Risposta

DeliveryData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.
created_atStringObbligatorju

Ħin tal-ħolqien.

format: "date-time"
Eżempju: "2026-01-01T12:00:00Z"
deleted_atString nullObbligatorju

Ħin tat-tħassir, jekk preżenti.

String:format: "date-time"
Eżempju: null
delivered_atStringObbligatorju

Data u ħin tal-kunsinna.

format: "date-time"
Eżempju: "2026-01-01T12:00:00Z"
idStringObbligatorju

Identifikatur tar-riżorsa; żommu kif mogħti. (DeliveryData).

Eżempju: "example"
increases_stockBooleanObbligatorju

Jekk ir-riċeviment tal-kunsinna jżidx l-istokk.

Eżempju: true
location_idStringObbligatorju

Identifikatur tal-post fil-maħżen.

Eżempju: "example"
quantityNumru sħiħObbligatorju

Numru ta’ unitajiet.

Eżempju: 1
received_atString nullObbligatorju

Data u ħin meta waslet il-kunsinna.

String:format: "date-time"
Eżempju: null
record_statusStringObbligatorju

Status tar-rekord maħżun.

Restrizzjonijiet
enum
["active", "deleted"]
Eżempju: "active"
statusStringObbligatorju

Status aċċettat minn din l-operazzjoni speċifika.

Restrizzjonijiet
enum
["planned", "received"]
Eżempju: "planned"
stock_applied_atString nullObbligatorju

Data u ħin meta ġiet applikata l-bidla fl-istokk tal-kunsinna.

String:format: "date-time"
Eżempju: null
target_idStringObbligatorju

Identifikatur tal-prodott jew tal-varjant affettwat mill-operazzjoni.

Eżempju: "example"
target_typeStringObbligatorju

Jekk l-operazzjoni tirrigwardax prodott jew varjant.

Restrizzjonijiet
enum
["product", "variant"]
Eżempju: "product"
updated_atString nullObbligatorju

Ħin tal-aktar aġġornament reċenti.

String:format: "date-time"
Eżempju: "2026-01-01T12:00:00Z"
versionNumru sħiħObbligatorju

Verżjoni tar-riżorsa għall-kontroll tal-konkorrenza.

Eżempju: 1
warehouse_idStringObbligatorju

Identifikatur tal-maħżen.

Eżempju: "example"

Oqsma addizzjonali: Le

Ikseb — Kunsinni deħlin — Risposta

DeliveryDetailData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.
created_atStringObbligatorju

Ħin tal-ħolqien.

format: "date-time"
Eżempju: "2026-01-01T12:00:00Z"
deleted_atString nullObbligatorju

Ħin tat-tħassir, jekk preżenti.

String:format: "date-time"
Eżempju: null
delivered_atStringObbligatorju

Data u ħin tal-kunsinna.

format: "date-time"
Eżempju: "2026-01-01T12:00:00Z"
idStringObbligatorju

Identifikatur tar-riżorsa; żommu kif mogħti. (DeliveryDetailData).

Eżempju: "example"
increases_stockBooleanObbligatorju

Jekk ir-riċeviment tal-kunsinna jżidx l-istokk.

Eżempju: true
location_idStringObbligatorju

Identifikatur tal-post fil-maħżen.

Eżempju: "example"
notesString nullObbligatorju

Noti addizzjonali.

Eżempju: "example"
quantityNumru sħiħObbligatorju

Numru ta’ unitajiet.

Eżempju: 1
received_atString nullObbligatorju

Data u ħin meta waslet il-kunsinna.

String:format: "date-time"
Eżempju: null
record_statusStringObbligatorju

Status tar-rekord maħżun.

Restrizzjonijiet
enum
["active", "deleted"]
Eżempju: "active"
statusStringObbligatorju

Status aċċettat minn din l-operazzjoni speċifika.

Restrizzjonijiet
enum
["planned", "received"]
Eżempju: "planned"
stock_applied_atString nullObbligatorju

Data u ħin meta ġiet applikata l-bidla fl-istokk tal-kunsinna.

String:format: "date-time"
Eżempju: null
target_idStringObbligatorju

Identifikatur tal-prodott jew tal-varjant affettwat mill-operazzjoni.

Eżempju: "example"
target_typeStringObbligatorju

Jekk l-operazzjoni tirrigwardax prodott jew varjant.

Restrizzjonijiet
enum
["product", "variant"]
Eżempju: "product"
updated_atString nullObbligatorju

Ħin tal-aktar aġġornament reċenti.

String:format: "date-time"
Eżempju: "2026-01-01T12:00:00Z"
versionNumru sħiħObbligatorju

Verżjoni tar-riżorsa għall-kontroll tal-konkorrenza.

Eżempju: 1
warehouse_idStringObbligatorju

Identifikatur tal-maħżen.

Eżempju: "example"

Oqsma addizzjonali: Le