Pereiti prie turinio
ShopentlyLearn

Duomenų schemos: Tiekimai

Duomenų schemos: Tiekimai. API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

Duomenų schemos

Gauti — Tiekimai — Atsakymas

ApiResponse_DeliveryDetailData_ · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.
dataDeliveryDetailData Privalomas

Atsakymo pavyzdys · DeliveryDetailData.

Pavyzdys: {"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 Privalomas

Atsakymo metaduomenys.

Pavyzdys: {"request_id":"example"}

Papildomi laukai: Ne

Sąrašas — Tiekimai — Atsakymas

ApiResponse_list_DeliveryData__ · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.
dataMasyvas <DeliveryData > Privalomas

Atsakymo pavyzdys · ApiResponse_list_DeliveryData__.

Pavyzdys: [{"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 Privalomas

Atsakymo metaduomenys.

Pavyzdys: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Papildomi laukai: Ne

Sukurti — Tiekimai — Užklausos turinys

DeliveryCreate · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.
delivered_atEilutėPrivalomas

Pristatymo data ir laikas.

format: "date-time"
Pavyzdys: "2026-01-01T00:00:00Z"
increases_stockLoginė reikšmėNeprivalomas

Ar tiekimo priėmimas padidina atsargas.

Numatytoji reikšmė: true
location_idEilutėPrivalomas

Sandėlio vietos identifikatorius.

Apribojimai
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Pavyzdys: "example"
notesEilutėNeprivalomas

Papildomos pastabos.

maxLength: 2000
Numatytoji reikšmė: ""
quantitySveikasis skaičiusPrivalomas

Vienetų skaičius.

minimum: 1maximum: 2147483647
Pavyzdys: 1
reasonEilutėNeprivalomas

Užregistruota pakeitimo priežastis.

maxLength: 500
Numatytoji reikšmė: ""
statusEilutėPrivalomas

Šios konkrečios operacijos priimama būsena.

Apribojimai
enum
["planned", "received"]
Pavyzdys: "planned"
target_idEilutėPrivalomas

Operacijos paveikto produkto arba varianto identifikatorius.

Apribojimai
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Pavyzdys: "example"
target_typeEilutėPrivalomas

Ar operacija skirta produktui, ar variantui.

Apribojimai
enum
["product", "variant"]
Pavyzdys: "product"
warehouse_idEilutėPrivalomas

Sandėlio identifikatorius.

Apribojimai
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Pavyzdys: "example"

Papildomi laukai: Ne

Sąrašas — Tiekimai — Atsakymas

DeliveryData · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.
created_atEilutėPrivalomas

Sukūrimo laikas.

format: "date-time"
Pavyzdys: "2026-01-01T12:00:00Z"
deleted_atEilutė nullPrivalomas

Pašalinimo laikas, jei yra.

Eilutė:format: "date-time"
Pavyzdys: null
delivered_atEilutėPrivalomas

Pristatymo data ir laikas.

format: "date-time"
Pavyzdys: "2026-01-01T12:00:00Z"
idEilutėPrivalomas

Ištekliaus identifikatorius; išsaugokite grąžintą išraišką. (DeliveryData).

Pavyzdys: "example"
increases_stockLoginė reikšmėPrivalomas

Ar tiekimo priėmimas padidina atsargas.

Pavyzdys: true
location_idEilutėPrivalomas

Sandėlio vietos identifikatorius.

Pavyzdys: "example"
quantitySveikasis skaičiusPrivalomas

Vienetų skaičius.

Pavyzdys: 1
received_atEilutė nullPrivalomas

Tiekimo priėmimo data ir laikas.

Eilutė:format: "date-time"
Pavyzdys: null
record_statusEilutėPrivalomas

Išsaugoto įrašo būsena.

Apribojimai
enum
["active", "deleted"]
Pavyzdys: "active"
statusEilutėPrivalomas

Šios konkrečios operacijos priimama būsena.

Apribojimai
enum
["planned", "received"]
Pavyzdys: "planned"
stock_applied_atEilutė nullPrivalomas

Data ir laikas, kai pritaikytas tiekimo atsargų pakeitimas.

Eilutė:format: "date-time"
Pavyzdys: null
target_idEilutėPrivalomas

Operacijos paveikto produkto arba varianto identifikatorius.

Pavyzdys: "example"
target_typeEilutėPrivalomas

Ar operacija skirta produktui, ar variantui.

Apribojimai
enum
["product", "variant"]
Pavyzdys: "product"
updated_atEilutė nullPrivalomas

Paskutinio atnaujinimo laikas.

Eilutė:format: "date-time"
Pavyzdys: "2026-01-01T12:00:00Z"
versionSveikasis skaičiusPrivalomas

Ištekliaus versija lygiagrečių pakeitimų kontrolei.

Pavyzdys: 1
warehouse_idEilutėPrivalomas

Sandėlio identifikatorius.

Pavyzdys: "example"

Papildomi laukai: Ne

Gauti — Tiekimai — Atsakymas

DeliveryDetailData · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.
created_atEilutėPrivalomas

Sukūrimo laikas.

format: "date-time"
Pavyzdys: "2026-01-01T12:00:00Z"
deleted_atEilutė nullPrivalomas

Pašalinimo laikas, jei yra.

Eilutė:format: "date-time"
Pavyzdys: null
delivered_atEilutėPrivalomas

Pristatymo data ir laikas.

format: "date-time"
Pavyzdys: "2026-01-01T12:00:00Z"
idEilutėPrivalomas

Ištekliaus identifikatorius; išsaugokite grąžintą išraišką. (DeliveryDetailData).

Pavyzdys: "example"
increases_stockLoginė reikšmėPrivalomas

Ar tiekimo priėmimas padidina atsargas.

Pavyzdys: true
location_idEilutėPrivalomas

Sandėlio vietos identifikatorius.

Pavyzdys: "example"
notesEilutė nullPrivalomas

Papildomos pastabos.

Pavyzdys: "example"
quantitySveikasis skaičiusPrivalomas

Vienetų skaičius.

Pavyzdys: 1
received_atEilutė nullPrivalomas

Tiekimo priėmimo data ir laikas.

Eilutė:format: "date-time"
Pavyzdys: null
record_statusEilutėPrivalomas

Išsaugoto įrašo būsena.

Apribojimai
enum
["active", "deleted"]
Pavyzdys: "active"
statusEilutėPrivalomas

Šios konkrečios operacijos priimama būsena.

Apribojimai
enum
["planned", "received"]
Pavyzdys: "planned"
stock_applied_atEilutė nullPrivalomas

Data ir laikas, kai pritaikytas tiekimo atsargų pakeitimas.

Eilutė:format: "date-time"
Pavyzdys: null
target_idEilutėPrivalomas

Operacijos paveikto produkto arba varianto identifikatorius.

Pavyzdys: "example"
target_typeEilutėPrivalomas

Ar operacija skirta produktui, ar variantui.

Apribojimai
enum
["product", "variant"]
Pavyzdys: "product"
updated_atEilutė nullPrivalomas

Paskutinio atnaujinimo laikas.

Eilutė:format: "date-time"
Pavyzdys: "2026-01-01T12:00:00Z"
versionSveikasis skaičiusPrivalomas

Ištekliaus versija lygiagrečių pakeitimų kontrolei.

Pavyzdys: 1
warehouse_idEilutėPrivalomas

Sandėlio identifikatorius.

Pavyzdys: "example"

Papildomi laukai: Ne