Schemi dei dati: Scorte

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

Schemi dei dati

Quantità assegnate alle ubicazioni del magazzino

AllocationData · Schema · Schemi dei dati: Scorte

location_codeStringaObbligatorio: Codice dell’ubicazione nel magazzino.

Esempio: "example"
location_idStringaObbligatorio: Identificativo dell’ubicazione nel magazzino.

Esempio: "example"
location_nameStringaObbligatorio: Nome dell’ubicazione nel magazzino.

Esempio: "example"
on_handInteroObbligatorio: Quantità fisicamente presente.

Esempio: 10

Campi aggiuntivi: No

Elenca · Giacenze — Scorte — Risposta

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

dataArray <StockData > Obbligatorio: Esempio di risposta · ApiResponse_list_StockData__.

Esempio: [{"active":true,"available":5,"id":"stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ","manual_reserved":2,"on_hand":10,"reserved":3,"sellable_limit":10,"target_id":"example","target_type":"product","total_reserved":5,"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

Recupera · Giacenze — Scorte — Risposta

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

dataStockDetailData Obbligatorio: Esempio di risposta · StockDetailData.

Esempio: {"active":true,"allocations":[{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}],"available":5,"id":"stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ","manual_reserved":2,"on_hand":10,"reserved":3,"sellable_limit":10,"target_id":"example","target_type":"product","total_reserved":5,"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

Aggiorna · Prenotazione manuale — Scorte — Corpo della richiesta

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

expected_versionInteroObbligatorio: Versione letta prima della scrittura; una differenza impedisce l’aggiornamento.

minimum: 1maximum: 9223372036854775807

Esempio: 1
manual_reservedInteroObbligatorio: Quantità prenotata manualmente.

minimum: 0maximum: 2147483647

Esempio: 1
reasonStringaFacoltativo: Motivo registrato per la modifica.

maxLength: 500

Valore predefinito: ""

Campi aggiuntivi: No

Aggiorna · Limite di vendita — Scorte — Corpo della richiesta

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

expected_versionInteroObbligatorio: Versione letta prima della scrittura; una differenza impedisce l’aggiornamento.

minimum: 1maximum: 9223372036854775807

Esempio: 1
reasonStringaFacoltativo: Motivo registrato per la modifica.

maxLength: 500

Valore predefinito: ""
sellable_limitInteroObbligatorio: Limite di vendita: -1 indica assenza di limite e 0 disabilita la disponibilità alla vendita.

minimum: -1maximum: 2147483647

Esempio: 1

Campi aggiuntivi: No

Crea · Rettifica delle giacenze — Scorte — Corpo della richiesta

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

expected_versionInteroObbligatorio

Versione letta prima della scrittura; una differenza impedisce l’aggiornamento.

minimum: 0maximum: 9223372036854775807

Esempio: 0

locationsArray <LocationQuantity > Obbligatorio

Ubicazioni del magazzino.

minItems: 1maxItems: 100

Esempio: [{"location_id":"example","on_hand":1}]

reasonStringaObbligatorio

Motivo registrato per la modifica.

minLength: 1maxLength: 500

Esempio: "Example"

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

Aggiorna · Giacenze — Scorte — Corpo della richiesta

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

expected_versionInteroObbligatorio: Versione letta prima della scrittura; una differenza impedisce l’aggiornamento.

minimum: 1maximum: 9223372036854775807

Esempio: 1
locationsArray <LocationQuantity > Obbligatorio: Ubicazioni del magazzino.

minItems: 1maxItems: 100

Esempio: [{"location_id":"example","on_hand":1}]
reasonStringaObbligatorio: Motivo registrato per la modifica.

minLength: 1maxLength: 500

Esempio: "Example"

Campi aggiuntivi: No

Elenca · Giacenze — Scorte — Risposta

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

activeBooleanoObbligatorio

Indica se la risorsa è attiva.

Esempio: true

availableIntero nullObbligatorio

Quantità disponibile alla vendita; null indica una quantità illimitata.

Esempio: 5

idStringaObbligatorio

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

Esempio: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedInteroObbligatorio

Quantità prenotata manualmente.

Esempio: 2

on_handInteroObbligatorio

Quantità fisicamente presente.

Esempio: 10

reservedInteroObbligatorio

Quantità prenotata dagli ordini.

Esempio: 3

sellable_limitInteroObbligatorio

Limite di vendita: -1 indica assenza di limite e 0 disabilita la disponibilità alla vendita.

Esempio: 10

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"

total_reservedInteroObbligatorio

Quantità totale prenotata.

Esempio: 5

updated_atStringaObbligatorio

Data e ora dell’aggiornamento più recente.

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 · Giacenze — Scorte — Risposta

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

activeBooleanoObbligatorio

Indica se la risorsa è attiva.

Esempio: true

allocationsArray <AllocationData > Obbligatorio

Quantità assegnate alle ubicazioni del magazzino.

Esempio: [{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}]

availableIntero nullObbligatorio

Quantità disponibile alla vendita; null indica una quantità illimitata.

Esempio: 5

idStringaObbligatorio

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

Esempio: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedInteroObbligatorio

Quantità prenotata manualmente.

Esempio: 2

on_handInteroObbligatorio

Quantità fisicamente presente.

Esempio: 10

reservedInteroObbligatorio

Quantità prenotata dagli ordini.

Esempio: 3

sellable_limitInteroObbligatorio

Limite di vendita: -1 indica assenza di limite e 0 disabilita la disponibilità alla vendita.

Esempio: 10

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"

total_reservedInteroObbligatorio

Quantità totale prenotata.

Esempio: 5

updated_atStringaObbligatorio

Data e ora dell’aggiornamento più recente.

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