Tietoskeemat: Varastotoimitukset

Tietoskeemat: Varastotoimitukset. API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

Tietoskeemat

Hae — Varastotoimitukset — Vastaus

ApiResponse_DeliveryDetailData_ · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

dataDeliveryDetailData Pakollinen: Vastausesimerkki · DeliveryDetailData.

Esimerkki: {"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 Pakollinen: Vastauksen metatiedot.

Esimerkki: {"request_id":"example"}

Lisäkentät: Ei

Listaa — Varastotoimitukset — Vastaus

ApiResponse_list_DeliveryData__ · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

dataTaulukko <DeliveryData > Pakollinen: Vastausesimerkki · ApiResponse_list_DeliveryData__.

Esimerkki: [{"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 Pakollinen: Vastauksen metatiedot.

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

Lisäkentät: Ei

Luo — Varastotoimitukset — Pyynnön sisältö

DeliveryCreate · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

delivered_atMerkkijonoPakollinen

Toimituspäivä ja -aika.

format: "date-time"

Esimerkki: "2026-01-01T00:00:00Z"

increases_stockTotuusarvoValinnainen

Kasvattaako toimituksen vastaanotto varastosaldoa.

Oletus: true

location_idMerkkijonoPakollinen

Varastosijainnin tunniste.

Rajoitukset

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

Esimerkki: "example"

notesMerkkijonoValinnainen

Lisähuomautukset.

maxLength: 2000

Oletus: ""

quantityKokonaislukuPakollinen

Yksiköiden määrä.

minimum: 1maximum: 2147483647

Esimerkki: 1

reasonMerkkijonoValinnainen

Muutokselle kirjattu syy.

maxLength: 500

Oletus: ""

statusMerkkijonoPakollinen

Tämän nimenomaisen toiminnon hyväksymä tila.

Rajoitukset

enum: ["planned", "received"]

Esimerkki: "planned"

target_idMerkkijonoPakollinen

Toiminnon kohteena olevan tuotteen tai variantin tunniste.

Rajoitukset

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

Esimerkki: "example"

target_typeMerkkijonoPakollinen

Koskeeko toiminto tuotetta vai varianttia.

Rajoitukset

enum: ["product", "variant"]

Esimerkki: "product"

warehouse_idMerkkijonoPakollinen

Varaston tunniste.

Rajoitukset

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

Esimerkki: "example"

Lisäkentät: Ei

Listaa — Varastotoimitukset — Vastaus

DeliveryData · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

created_atMerkkijonoPakollinen

Luontiajankohta.

format: "date-time"

Esimerkki: "2026-01-01T12:00:00Z"

deleted_atMerkkijono nullPakollinen

Poistoajankohta, jos se on olemassa.

Merkkijono:format: "date-time"

Esimerkki: null

delivered_atMerkkijonoPakollinen

Toimituspäivä ja -aika.

format: "date-time"

Esimerkki: "2026-01-01T12:00:00Z"

idMerkkijonoPakollinen

Resurssin tunniste; säilytä se palautetussa muodossa. (DeliveryData).

Esimerkki: "example"

increases_stockTotuusarvoPakollinen

Kasvattaako toimituksen vastaanotto varastosaldoa.

Esimerkki: true

location_idMerkkijonoPakollinen

Varastosijainnin tunniste.

Esimerkki: "example"

quantityKokonaislukuPakollinen

Yksiköiden määrä.

Esimerkki: 1

received_atMerkkijono nullPakollinen

Toimituksen vastaanoton päivämäärä ja aika.

Merkkijono:format: "date-time"

Esimerkki: null

record_statusMerkkijonoPakollinen

Tallennetun tietueen tila.

Rajoitukset

enum: ["active", "deleted"]

Esimerkki: "active"

statusMerkkijonoPakollinen

Tämän nimenomaisen toiminnon hyväksymä tila.

Rajoitukset

enum: ["planned", "received"]

Esimerkki: "planned"

stock_applied_atMerkkijono nullPakollinen

Päivämäärä ja aika, jolloin toimituksen saldomuutos toteutettiin.

Merkkijono:format: "date-time"

Esimerkki: null

target_idMerkkijonoPakollinen

Toiminnon kohteena olevan tuotteen tai variantin tunniste.

Esimerkki: "example"

target_typeMerkkijonoPakollinen

Koskeeko toiminto tuotetta vai varianttia.

Rajoitukset

enum: ["product", "variant"]

Esimerkki: "product"

updated_atMerkkijono nullPakollinen

Viimeisimmän päivityksen ajankohta.

Merkkijono:format: "date-time"

Esimerkki: "2026-01-01T12:00:00Z"

versionKokonaislukuPakollinen

Samanaikaisuuden hallintaan käytetty resurssiversio.

Esimerkki: 1

warehouse_idMerkkijonoPakollinen

Varaston tunniste.

Esimerkki: "example"

Lisäkentät: Ei

Hae — Varastotoimitukset — Vastaus

DeliveryDetailData · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

created_atMerkkijonoPakollinen

Luontiajankohta.

format: "date-time"

Esimerkki: "2026-01-01T12:00:00Z"

deleted_atMerkkijono nullPakollinen

Poistoajankohta, jos se on olemassa.

Merkkijono:format: "date-time"

Esimerkki: null

delivered_atMerkkijonoPakollinen

Toimituspäivä ja -aika.

format: "date-time"

Esimerkki: "2026-01-01T12:00:00Z"

idMerkkijonoPakollinen

Resurssin tunniste; säilytä se palautetussa muodossa. (DeliveryDetailData).

Esimerkki: "example"

increases_stockTotuusarvoPakollinen

Kasvattaako toimituksen vastaanotto varastosaldoa.

Esimerkki: true

location_idMerkkijonoPakollinen

Varastosijainnin tunniste.

Esimerkki: "example"

notesMerkkijono nullPakollinen

Lisähuomautukset.

Esimerkki: "example"

quantityKokonaislukuPakollinen

Yksiköiden määrä.

Esimerkki: 1

received_atMerkkijono nullPakollinen

Toimituksen vastaanoton päivämäärä ja aika.

Merkkijono:format: "date-time"

Esimerkki: null

record_statusMerkkijonoPakollinen

Tallennetun tietueen tila.

Rajoitukset

enum: ["active", "deleted"]

Esimerkki: "active"

statusMerkkijonoPakollinen

Tämän nimenomaisen toiminnon hyväksymä tila.

Rajoitukset

enum: ["planned", "received"]

Esimerkki: "planned"

stock_applied_atMerkkijono nullPakollinen

Päivämäärä ja aika, jolloin toimituksen saldomuutos toteutettiin.

Merkkijono:format: "date-time"

Esimerkki: null

target_idMerkkijonoPakollinen

Toiminnon kohteena olevan tuotteen tai variantin tunniste.

Esimerkki: "example"

target_typeMerkkijonoPakollinen

Koskeeko toiminto tuotetta vai varianttia.

Rajoitukset

enum: ["product", "variant"]

Esimerkki: "product"

updated_atMerkkijono nullPakollinen

Viimeisimmän päivityksen ajankohta.

Merkkijono:format: "date-time"

Esimerkki: "2026-01-01T12:00:00Z"

versionKokonaislukuPakollinen

Samanaikaisuuden hallintaan käytetty resurssiversio.

Esimerkki: 1

warehouse_idMerkkijonoPakollinen

Varaston tunniste.

Esimerkki: "example"

Lisäkentät: Ei