Schemi dei dati: Forniture

Schemi dei dati: Forniture. Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

Schemi dei dati

Recupera — Forniture — Risposta

ApiResponse_DeliveryDetailData_ · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

dataDeliveryDetailData Obbligatorio: Esempio di risposta · DeliveryDetailData.

Esempio: {"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 Obbligatorio: Metadati della risposta.

Esempio: {"request_id":"example"}

Campi aggiuntivi: No

Elenca — Forniture — Risposta

ApiResponse_list_DeliveryData__ · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

dataArray <DeliveryData > Obbligatorio: Esempio di risposta · ApiResponse_list_DeliveryData__.

Esempio: [{"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 Obbligatorio: Metadati della risposta.

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

Campi aggiuntivi: No

Crea — Forniture — Corpo della richiesta

DeliveryCreate · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

delivered_atStringaObbligatorio

Data e ora di consegna.

format: "date-time"

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

increases_stockBooleanoFacoltativo

Indica se la ricezione della fornitura aumenta le scorte.

Valore predefinito: true

location_idStringaObbligatorio

Identificativo dell’ubicazione nel magazzino.

Vincoli

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

Esempio: "example"

notesStringaFacoltativo

Note aggiuntive.

maxLength: 2000

Valore predefinito: ""

quantityInteroObbligatorio

Numero di unità.

minimum: 1maximum: 2147483647

Esempio: 1

reasonStringaFacoltativo

Motivo registrato per la modifica.

maxLength: 500

Valore predefinito: ""

statusStringaObbligatorio

Stato accettato da questa specifica operazione.

Vincoli

enum: ["planned", "received"]

Esempio: "planned"

target_idStringaObbligatorio

Identificativo del prodotto o della variante interessati dall’operazione.

Vincoli

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

Esempio: "example"

target_typeStringaObbligatorio

Indica se l’operazione riguarda un prodotto o una variante.

Vincoli

enum: ["product", "variant"]

Esempio: "product"

warehouse_idStringaObbligatorio

Identificativo del magazzino.

Vincoli

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

Esempio: "example"

Campi aggiuntivi: No

Elenca — Forniture — Risposta

DeliveryData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

created_atStringaObbligatorio

Data e ora di creazione.

format: "date-time"

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

deleted_atStringa nullObbligatorio

Data e ora di eliminazione, se presenti.

Stringa:format: "date-time"

Esempio: null

delivered_atStringaObbligatorio

Data e ora di consegna.

format: "date-time"

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

idStringaObbligatorio

Identificativo della risorsa; conservalo come restituito. (DeliveryData).

Esempio: "example"

increases_stockBooleanoObbligatorio

Indica se la ricezione della fornitura aumenta le scorte.

Esempio: true

location_idStringaObbligatorio

Identificativo dell’ubicazione nel magazzino.

Esempio: "example"

quantityInteroObbligatorio

Numero di unità.

Esempio: 1

received_atStringa nullObbligatorio

Data e ora di ricezione della fornitura.

Stringa:format: "date-time"

Esempio: null

record_statusStringaObbligatorio

Stato del record salvato.

Vincoli

enum: ["active", "deleted"]

Esempio: "active"

statusStringaObbligatorio

Stato accettato da questa specifica operazione.

Vincoli

enum: ["planned", "received"]

Esempio: "planned"

stock_applied_atStringa nullObbligatorio

Data e ora di applicazione della variazione delle scorte causata dalla fornitura.

Stringa:format: "date-time"

Esempio: null

target_idStringaObbligatorio

Identificativo del prodotto o della variante interessati dall’operazione.

Esempio: "example"

target_typeStringaObbligatorio

Indica se l’operazione riguarda un prodotto o una variante.

Vincoli

enum: ["product", "variant"]

Esempio: "product"

updated_atStringa nullObbligatorio

Data e ora dell’aggiornamento più recente.

Stringa:format: "date-time"

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

versionInteroObbligatorio

Versione della risorsa per il controllo della concorrenza.

Esempio: 1

warehouse_idStringaObbligatorio

Identificativo del magazzino.

Esempio: "example"

Campi aggiuntivi: No

Recupera — Forniture — Risposta

DeliveryDetailData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

created_atStringaObbligatorio

Data e ora di creazione.

format: "date-time"

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

deleted_atStringa nullObbligatorio

Data e ora di eliminazione, se presenti.

Stringa:format: "date-time"

Esempio: null

delivered_atStringaObbligatorio

Data e ora di consegna.

format: "date-time"

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

idStringaObbligatorio

Identificativo della risorsa; conservalo come restituito. (DeliveryDetailData).

Esempio: "example"

increases_stockBooleanoObbligatorio

Indica se la ricezione della fornitura aumenta le scorte.

Esempio: true

location_idStringaObbligatorio

Identificativo dell’ubicazione nel magazzino.

Esempio: "example"

notesStringa nullObbligatorio

Note aggiuntive.

Esempio: "example"

quantityInteroObbligatorio

Numero di unità.

Esempio: 1

received_atStringa nullObbligatorio

Data e ora di ricezione della fornitura.

Stringa:format: "date-time"

Esempio: null

record_statusStringaObbligatorio

Stato del record salvato.

Vincoli

enum: ["active", "deleted"]

Esempio: "active"

statusStringaObbligatorio

Stato accettato da questa specifica operazione.

Vincoli

enum: ["planned", "received"]

Esempio: "planned"

stock_applied_atStringa nullObbligatorio

Data e ora di applicazione della variazione delle scorte causata dalla fornitura.

Stringa:format: "date-time"

Esempio: null

target_idStringaObbligatorio

Identificativo del prodotto o della variante interessati dall’operazione.

Esempio: "example"

target_typeStringaObbligatorio

Indica se l’operazione riguarda un prodotto o una variante.

Vincoli

enum: ["product", "variant"]

Esempio: "product"

updated_atStringa nullObbligatorio

Data e ora dell’aggiornamento più recente.

Stringa:format: "date-time"

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

versionInteroObbligatorio

Versione della risorsa per il controllo della concorrenza.

Esempio: 1

warehouse_idStringaObbligatorio

Identificativo del magazzino.

Esempio: "example"

Campi aggiuntivi: No