Preskočiť na obsah
ShopentlyLearn

Dátové schémy: Dodávky

Dátové schémy: Dodávky. Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

Dátové schémy

Načítať — Dodávky — Odpoveď

ApiResponse_DeliveryDetailData_ · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
dataDeliveryDetailData Povinné

Príklad odpovede · DeliveryDetailData.

Príklad: {"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 Povinné

Metaúdaje odpovede.

Príklad: {"request_id":"example"}

Ďalšie polia: Nie

Zobraziť zoznam — Dodávky — Odpoveď

ApiResponse_list_DeliveryData__ · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
dataPole <DeliveryData > Povinné

Príklad odpovede · ApiResponse_list_DeliveryData__.

Príklad: [{"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 Povinné

Metaúdaje odpovede.

Príklad: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Ďalšie polia: Nie

Vytvoriť — Dodávky — Telo požiadavky

DeliveryCreate · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
delivered_atReťazecPovinné

Dátum a čas dodania.

format: "date-time"
Príklad: "2026-01-01T00:00:00Z"
increases_stockLogická hodnotaVoliteľné

Či prijatie dodávky zvýši zásoby.

Predvolená hodnota: true
location_idReťazecPovinné

Identifikátor skladového umiestnenia.

Obmedzenia
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Príklad: "example"
notesReťazecVoliteľné

Doplňujúce poznámky.

maxLength: 2000
Predvolená hodnota: ""
quantityCelé čísloPovinné

Počet jednotiek.

minimum: 1maximum: 2147483647
Príklad: 1
reasonReťazecVoliteľné

Dôvod zaznamenaný pri zmene.

maxLength: 500
Predvolená hodnota: ""
statusReťazecPovinné

Stav prijímaný touto konkrétnou operáciou.

Obmedzenia
enum
["planned", "received"]
Príklad: "planned"
target_idReťazecPovinné

Identifikátor produktu alebo variantu, ktorého sa operácia týka.

Obmedzenia
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Príklad: "example"
target_typeReťazecPovinné

Či sa operácia týka produktu alebo variantu.

Obmedzenia
enum
["product", "variant"]
Príklad: "product"
warehouse_idReťazecPovinné

Identifikátor skladu.

Obmedzenia
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Príklad: "example"

Ďalšie polia: Nie

Zobraziť zoznam — Dodávky — Odpoveď

DeliveryData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
created_atReťazecPovinné

Čas vytvorenia.

format: "date-time"
Príklad: "2026-01-01T12:00:00Z"
deleted_atReťazec nullPovinné

Čas zmazania, ak existuje.

Reťazec:format: "date-time"
Príklad: null
delivered_atReťazecPovinné

Dátum a čas dodania.

format: "date-time"
Príklad: "2026-01-01T12:00:00Z"
idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený. (DeliveryData).

Príklad: "example"
increases_stockLogická hodnotaPovinné

Či prijatie dodávky zvýši zásoby.

Príklad: true
location_idReťazecPovinné

Identifikátor skladového umiestnenia.

Príklad: "example"
quantityCelé čísloPovinné

Počet jednotiek.

Príklad: 1
received_atReťazec nullPovinné

Dátum a čas prijatia dodávky.

Reťazec:format: "date-time"
Príklad: null
record_statusReťazecPovinné

Uložený stav záznamu.

Obmedzenia
enum
["active", "deleted"]
Príklad: "active"
statusReťazecPovinné

Stav prijímaný touto konkrétnou operáciou.

Obmedzenia
enum
["planned", "received"]
Príklad: "planned"
stock_applied_atReťazec nullPovinné

Dátum a čas vykonania zmeny zásob z tejto dodávky.

Reťazec:format: "date-time"
Príklad: null
target_idReťazecPovinné

Identifikátor produktu alebo variantu, ktorého sa operácia týka.

Príklad: "example"
target_typeReťazecPovinné

Či sa operácia týka produktu alebo variantu.

Obmedzenia
enum
["product", "variant"]
Príklad: "product"
updated_atReťazec nullPovinné

Čas poslednej aktualizácie.

Reťazec:format: "date-time"
Príklad: "2026-01-01T12:00:00Z"
versionCelé čísloPovinné

Verzia zdroja používaná na riadenie súbežných zmien.

Príklad: 1
warehouse_idReťazecPovinné

Identifikátor skladu.

Príklad: "example"

Ďalšie polia: Nie

Načítať — Dodávky — Odpoveď

DeliveryDetailData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
created_atReťazecPovinné

Čas vytvorenia.

format: "date-time"
Príklad: "2026-01-01T12:00:00Z"
deleted_atReťazec nullPovinné

Čas zmazania, ak existuje.

Reťazec:format: "date-time"
Príklad: null
delivered_atReťazecPovinné

Dátum a čas dodania.

format: "date-time"
Príklad: "2026-01-01T12:00:00Z"
idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený. (DeliveryDetailData).

Príklad: "example"
increases_stockLogická hodnotaPovinné

Či prijatie dodávky zvýši zásoby.

Príklad: true
location_idReťazecPovinné

Identifikátor skladového umiestnenia.

Príklad: "example"
notesReťazec nullPovinné

Doplňujúce poznámky.

Príklad: "example"
quantityCelé čísloPovinné

Počet jednotiek.

Príklad: 1
received_atReťazec nullPovinné

Dátum a čas prijatia dodávky.

Reťazec:format: "date-time"
Príklad: null
record_statusReťazecPovinné

Uložený stav záznamu.

Obmedzenia
enum
["active", "deleted"]
Príklad: "active"
statusReťazecPovinné

Stav prijímaný touto konkrétnou operáciou.

Obmedzenia
enum
["planned", "received"]
Príklad: "planned"
stock_applied_atReťazec nullPovinné

Dátum a čas vykonania zmeny zásob z tejto dodávky.

Reťazec:format: "date-time"
Príklad: null
target_idReťazecPovinné

Identifikátor produktu alebo variantu, ktorého sa operácia týka.

Príklad: "example"
target_typeReťazecPovinné

Či sa operácia týka produktu alebo variantu.

Obmedzenia
enum
["product", "variant"]
Príklad: "product"
updated_atReťazec nullPovinné

Čas poslednej aktualizácie.

Reťazec:format: "date-time"
Príklad: "2026-01-01T12:00:00Z"
versionCelé čísloPovinné

Verzia zdroja používaná na riadenie súbežných zmien.

Príklad: 1
warehouse_idReťazecPovinné

Identifikátor skladu.

Príklad: "example"

Ďalšie polia: Nie