Preskoči na vsebino
ShopentlyLearn

Podatkovne sheme: Dobave

Podatkovne sheme: Dobave. Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

Podatkovne sheme

Pridobi — Dobave — Odgovor

ApiResponse_DeliveryDetailData_ · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
dataDeliveryDetailData Obvezno

Primer odgovora · DeliveryDetailData.

Primer: {"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 Obvezno

Metapodatki odgovora.

Primer: {"request_id":"example"}

Dodatna polja: Ne

Prikaži seznam — Dobave — Odgovor

ApiResponse_list_DeliveryData__ · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
dataPolje elementov <DeliveryData > Obvezno

Primer odgovora · ApiResponse_list_DeliveryData__.

Primer: [{"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 Obvezno

Metapodatki odgovora.

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

Dodatna polja: Ne

Ustvari — Dobave — Telo zahteve

DeliveryCreate · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
delivered_atNizObvezno

Datum in čas dostave.

format: "date-time"
Primer: "2026-01-01T00:00:00Z"
increases_stockLogična vrednostIzbirno

Ali prejem dobave poveča zalogo.

Privzeto: true
location_idNizObvezno

Identifikator lokacije skladišča.

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

Dodatne opombe.

maxLength: 2000
Privzeto: ""
quantityCelo številoObvezno

Število enot.

minimum: 1maximum: 2147483647
Primer: 1
reasonNizIzbirno

Zabeleženi razlog spremembe.

maxLength: 500
Privzeto: ""
statusNizObvezno

Status, ki ga sprejema ta operacija.

Omejitve
enum
["planned", "received"]
Primer: "planned"
target_idNizObvezno

Identifikator izdelka ali različice, na katero vpliva operacija.

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

Ali se operacija nanaša na izdelek ali različico.

Omejitve
enum
["product", "variant"]
Primer: "product"
warehouse_idNizObvezno

Identifikator skladišča.

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

Dodatna polja: Ne

Prikaži seznam — Dobave — Odgovor

DeliveryData · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
created_atNizObvezno

Čas nastanka.

format: "date-time"
Primer: "2026-01-01T12:00:00Z"
deleted_atNiz nullObvezno

Čas izbrisa, če obstaja.

Niz:format: "date-time"
Primer: null
delivered_atNizObvezno

Datum in čas dostave.

format: "date-time"
Primer: "2026-01-01T12:00:00Z"
idNizObvezno

Identifikator vira; ohranite ga v vrnjeni obliki. (DeliveryData).

Primer: "example"
increases_stockLogična vrednostObvezno

Ali prejem dobave poveča zalogo.

Primer: true
location_idNizObvezno

Identifikator lokacije skladišča.

Primer: "example"
quantityCelo številoObvezno

Število enot.

Primer: 1
received_atNiz nullObvezno

Datum in čas prejema dobave.

Niz:format: "date-time"
Primer: null
record_statusNizObvezno

Status shranjenega zapisa.

Omejitve
enum
["active", "deleted"]
Primer: "active"
statusNizObvezno

Status, ki ga sprejema ta operacija.

Omejitve
enum
["planned", "received"]
Primer: "planned"
stock_applied_atNiz nullObvezno

Datum in čas uporabe spremembe zaloge zaradi dobave.

Niz:format: "date-time"
Primer: null
target_idNizObvezno

Identifikator izdelka ali različice, na katero vpliva operacija.

Primer: "example"
target_typeNizObvezno

Ali se operacija nanaša na izdelek ali različico.

Omejitve
enum
["product", "variant"]
Primer: "product"
updated_atNiz nullObvezno

Čas zadnje posodobitve.

Niz:format: "date-time"
Primer: "2026-01-01T12:00:00Z"
versionCelo številoObvezno

Različica vira za nadzor sočasnosti.

Primer: 1
warehouse_idNizObvezno

Identifikator skladišča.

Primer: "example"

Dodatna polja: Ne

Pridobi — Dobave — Odgovor

DeliveryDetailData · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
created_atNizObvezno

Čas nastanka.

format: "date-time"
Primer: "2026-01-01T12:00:00Z"
deleted_atNiz nullObvezno

Čas izbrisa, če obstaja.

Niz:format: "date-time"
Primer: null
delivered_atNizObvezno

Datum in čas dostave.

format: "date-time"
Primer: "2026-01-01T12:00:00Z"
idNizObvezno

Identifikator vira; ohranite ga v vrnjeni obliki. (DeliveryDetailData).

Primer: "example"
increases_stockLogična vrednostObvezno

Ali prejem dobave poveča zalogo.

Primer: true
location_idNizObvezno

Identifikator lokacije skladišča.

Primer: "example"
notesNiz nullObvezno

Dodatne opombe.

Primer: "example"
quantityCelo številoObvezno

Število enot.

Primer: 1
received_atNiz nullObvezno

Datum in čas prejema dobave.

Niz:format: "date-time"
Primer: null
record_statusNizObvezno

Status shranjenega zapisa.

Omejitve
enum
["active", "deleted"]
Primer: "active"
statusNizObvezno

Status, ki ga sprejema ta operacija.

Omejitve
enum
["planned", "received"]
Primer: "planned"
stock_applied_atNiz nullObvezno

Datum in čas uporabe spremembe zaloge zaradi dobave.

Niz:format: "date-time"
Primer: null
target_idNizObvezno

Identifikator izdelka ali različice, na katero vpliva operacija.

Primer: "example"
target_typeNizObvezno

Ali se operacija nanaša na izdelek ali različico.

Omejitve
enum
["product", "variant"]
Primer: "product"
updated_atNiz nullObvezno

Čas zadnje posodobitve.

Niz:format: "date-time"
Primer: "2026-01-01T12:00:00Z"
versionCelo številoObvezno

Različica vira za nadzor sočasnosti.

Primer: 1
warehouse_idNizObvezno

Identifikator skladišča.

Primer: "example"

Dodatna polja: Ne