Andmeskeemid: Tarned

Andmeskeemid: Tarned. API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

Andmeskeemid

Hangi — Tarned — Vastus

ApiResponse_DeliveryDetailData_ · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

dataDeliveryDetailData Kohustuslik: Vastuse näide · DeliveryDetailData.

Näide: {"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 Kohustuslik: Vastuse metaandmed.

Näide: {"request_id":"example"}

Lisaväljad: Ei

Loend — Tarned — Vastus

ApiResponse_list_DeliveryData__ · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

dataMassiiv <DeliveryData > Kohustuslik: Vastuse näide · ApiResponse_list_DeliveryData__.

Näide: [{"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 Kohustuslik: Vastuse metaandmed.

Näide: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Lisaväljad: Ei

Loo — Tarned — Päringu sisu

DeliveryCreate · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

delivered_atStringKohustuslik

Tarne kuupäev ja kellaaeg.

format: "date-time"

Näide: "2026-01-01T00:00:00Z"

increases_stockTõeväärtusValikuline

Kas tarne vastuvõtmine suurendab laoseisu.

Vaikeväärtus: true

location_idStringKohustuslik

Laoasukoha identifikaator.

Piirangud

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

Näide: "example"

notesStringValikuline

Lisamärkused.

maxLength: 2000

Vaikeväärtus: ""

quantityTäisarvKohustuslik

Ühikute arv.

minimum: 1maximum: 2147483647

Näide: 1

reasonStringValikuline

Muudatuse juurde salvestatud põhjus.

maxLength: 500

Vaikeväärtus: ""

statusStringKohustuslik

Selle konkreetse toimingu lubatud olek.

Piirangud

enum: ["planned", "received"]

Näide: "planned"

target_idStringKohustuslik

Toimingust mõjutatud toote või variandi identifikaator.

Piirangud

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

Näide: "example"

target_typeStringKohustuslik

Kas toiming puudutab toodet või varianti.

Piirangud

enum: ["product", "variant"]

Näide: "product"

warehouse_idStringKohustuslik

Lao identifikaator.

Piirangud

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

Näide: "example"

Lisaväljad: Ei

Loend — Tarned — Vastus

DeliveryData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

created_atStringKohustuslik

Loomise aeg.

format: "date-time"

Näide: "2026-01-01T12:00:00Z"

deleted_atString nullKohustuslik

Kustutamise aeg, kui see on olemas.

String:format: "date-time"

Näide: null

delivered_atStringKohustuslik

Tarne kuupäev ja kellaaeg.

format: "date-time"

Näide: "2026-01-01T12:00:00Z"

idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul. (DeliveryData).

Näide: "example"

increases_stockTõeväärtusKohustuslik

Kas tarne vastuvõtmine suurendab laoseisu.

Näide: true

location_idStringKohustuslik

Laoasukoha identifikaator.

Näide: "example"

quantityTäisarvKohustuslik

Ühikute arv.

Näide: 1

received_atString nullKohustuslik

Tarne vastuvõtmise kuupäev ja kellaaeg.

String:format: "date-time"

Näide: null

record_statusStringKohustuslik

Salvestatud kirje olek.

Piirangud

enum: ["active", "deleted"]

Näide: "active"

statusStringKohustuslik

Selle konkreetse toimingu lubatud olek.

Piirangud

enum: ["planned", "received"]

Näide: "planned"

stock_applied_atString nullKohustuslik

Tarne laomuutuse rakendamise kuupäev ja kellaaeg.

String:format: "date-time"

Näide: null

target_idStringKohustuslik

Toimingust mõjutatud toote või variandi identifikaator.

Näide: "example"

target_typeStringKohustuslik

Kas toiming puudutab toodet või varianti.

Piirangud

enum: ["product", "variant"]

Näide: "product"

updated_atString nullKohustuslik

Viimase uuendamise aeg.

String:format: "date-time"

Näide: "2026-01-01T12:00:00Z"

versionTäisarvKohustuslik

Ressursi versioon samaaegsuse kontrolliks.

Näide: 1

warehouse_idStringKohustuslik

Lao identifikaator.

Näide: "example"

Lisaväljad: Ei

Hangi — Tarned — Vastus

DeliveryDetailData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

created_atStringKohustuslik

Loomise aeg.

format: "date-time"

Näide: "2026-01-01T12:00:00Z"

deleted_atString nullKohustuslik

Kustutamise aeg, kui see on olemas.

String:format: "date-time"

Näide: null

delivered_atStringKohustuslik

Tarne kuupäev ja kellaaeg.

format: "date-time"

Näide: "2026-01-01T12:00:00Z"

idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul. (DeliveryDetailData).

Näide: "example"

increases_stockTõeväärtusKohustuslik

Kas tarne vastuvõtmine suurendab laoseisu.

Näide: true

location_idStringKohustuslik

Laoasukoha identifikaator.

Näide: "example"

notesString nullKohustuslik

Lisamärkused.

Näide: "example"

quantityTäisarvKohustuslik

Ühikute arv.

Näide: 1

received_atString nullKohustuslik

Tarne vastuvõtmise kuupäev ja kellaaeg.

String:format: "date-time"

Näide: null

record_statusStringKohustuslik

Salvestatud kirje olek.

Piirangud

enum: ["active", "deleted"]

Näide: "active"

statusStringKohustuslik

Selle konkreetse toimingu lubatud olek.

Piirangud

enum: ["planned", "received"]

Näide: "planned"

stock_applied_atString nullKohustuslik

Tarne laomuutuse rakendamise kuupäev ja kellaaeg.

String:format: "date-time"

Näide: null

target_idStringKohustuslik

Toimingust mõjutatud toote või variandi identifikaator.

Näide: "example"

target_typeStringKohustuslik

Kas toiming puudutab toodet või varianti.

Piirangud

enum: ["product", "variant"]

Näide: "product"

updated_atString nullKohustuslik

Viimase uuendamise aeg.

String:format: "date-time"

Näide: "2026-01-01T12:00:00Z"

versionTäisarvKohustuslik

Ressursi versioon samaaegsuse kontrolliks.

Näide: 1

warehouse_idStringKohustuslik

Lao identifikaator.

Näide: "example"

Lisaväljad: Ei