Vai al contenuto
ShopentlyLearn

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

ApiResponse[CodeContentData]

ApiResponse_CodeContentData_ · I codici vengono restituiti in JSON, i file come dati binari. Ogni richiesta richiede Bearer e il permesso reveal.
dataCodeContentData Obbligatorio

Contenuto di una risposta riuscita.

Esempio: {"code":"DEMO-ONE","delivery_id":null,"kind":"code","payload_id":"00000000-0000-4000-8000-000000000004","unit_id":"00000000-0000-4000-8000-000000000003"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorio

Metadati della risposta.

Esempio: {"request_id":"example-request"}

Campi aggiuntivi: No

ApiResponse[DigitalUploadData]

ApiResponse_DigitalUploadData_ · Verifica dimensione, checksum e formato. Un caricamento pronto non equivale a una consegna ricevuta.
dataDigitalUploadData Obbligatorio

Contenuto di una risposta riuscita.

Esempio: {"consumer_id":"00000000-0000-4000-8000-000000000001","consumer_kind":"digital_import","expires_at":"2026-11-03T13:00:00Z","filename":"codes.txt","id":"00000000-0000-4000-8000-000000000002","product_id":"example","purpose":"digital_import","received_bytes":18,"sha256":"636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a","size_bytes":18,"status":"ready"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorio

Metadati della risposta.

Esempio: {"request_id":"example-request"}

Campi aggiuntivi: No

ApiResponse[ImportData]

ApiResponse_ImportData_ · Controlla stato, versione e convalida. La bozza appartiene alla chiave API che l’ha creata.
dataImportData Obbligatorio

Contenuto di una risposta riuscita.

Esempio: {"delivery_id":null,"delivery_status":null,"delivery_version":null,"expected_count":2,"expires_at":"2026-11-03T13:00:00Z","id":"00000000-0000-4000-8000-000000000001","kind":"code","product_id":"example","status":"validated","validated_count":2,"validation_digest":"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb","version":2}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorio

Metadati della risposta.

Esempio: {"request_id":"example-request"}

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

ApiResponse[PoolData]

ApiResponse_PoolData_ · Consulta impostazioni e quantità prima di modificarle. La risposta non contiene codici o file.
dataPoolData Obbligatorio

Contenuto di una risposta riuscita.

Esempio: {"configured":true,"counts":{"available":1,"held":0,"issued":1,"planned":0,"retired":0,"staged":0},"email_mode":"order_link","enabled":true,"order_version":2,"product_id":"example","retention_days":null,"version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorio

Metadati della risposta.

Esempio: {"request_id":"example-request"}

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

ApiResponse[UnitsData]

ApiResponse_UnitsData_ · Leggi fino a 100 unità per pagina. L’elenco mostra i metadati senza rivelare i codici.
dataUnitsData Obbligatorio

Contenuto di una risposta riuscita.

Esempio: {"order_version":2,"total":1,"units":[{"content_state":"present","delivery_id":"delivery-example","filename":null,"id":"00000000-0000-4000-8000-000000000003","issued_at":null,"kind":"code","location_id":"location-digital","mime_type":null,"payload_id":"00000000-0000-4000-8000-000000000004","product_id":"example","size_bytes":null,"sort_order":1,"state":"available","version":1,"warehouse_id":"warehouse-main"}]}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorio

Metadati della risposta.

Esempio: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example-request"}

Campi aggiuntivi: No

CodeContentData

CodeContentData · I codici vengono restituiti in JSON, i file come dati binari. Ogni richiesta richiede Bearer e il permesso reveal.
codeStringaObbligatorio

Il codice digitale esatto. Mantieni maiuscole, minuscole e spazi interni.

minLength: 1maxLength: 512
Esempio: "DEMO-ONE"
delivery_idStringa nullFacoltativo

ID della consegna o dell’assegnazione all’ordine.

Stringa:format: "uuid"
Esempio: null
kindStringaFacoltativo

Forma della struttura dati, definita dai valori consentiti.

const: "code"
Valore predefinito: "code"Esempio: "code"
payload_idStringaObbligatorio

ID del contenuto, non un URL pubblico per il download.

format: "uuid"
Esempio: "00000000-0000-4000-8000-000000000004"
unit_idStringaObbligatorio

ID di un singolo codice o file.

format: "uuid"
Esempio: "00000000-0000-4000-8000-000000000003"

Campi aggiuntivi: No

DigitalUploadCreate

DigitalUploadCreate · Riserva spazio per un file e collegalo a un’importazione o all’unità da sostituire.
consumer_idStringaObbligatorio

ID dell’importazione o dell’unità associata.

format: "uuid"
Esempio: "00000000-0000-4000-8000-000000000001"
consumer_kindStringaObbligatorio

Destinazione del caricamento: digital_import / digital_unit.

Vincoli
enum
["digital_import", "digital_unit"]
Esempio: "digital_import"
filenameStringaObbligatorio

File

minLength: 1maxLength: 255
Esempio: "codes.txt"
purposeStringaObbligatorio

digital_import: TXT/CSV; digital_unit: file venduto singolarmente.

Vincoli
enum
["digital_unit", "digital_import"]
Esempio: "digital_import"
sha256StringaObbligatorio

SHA-256 (hex, 64)

Vincoli
pattern
"^[0-9a-f]{64}$"
Esempio: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"
size_bytesInteroObbligatorio

Dimensione in byte

minimum: 1maximum: 262144000
Esempio: 18

Campi aggiuntivi: No

DigitalUploadData

DigitalUploadData · Verifica dimensione, checksum e formato. Un caricamento pronto non equivale a una consegna ricevuta.
consumer_idStringaObbligatorio

ID dell’importazione o dell’unità associata.

format: "uuid"
Esempio: "00000000-0000-4000-8000-000000000001"
consumer_kindStringaObbligatorio

Destinazione del caricamento: digital_import / digital_unit.

Vincoli
enum
["digital_import", "digital_unit"]
Esempio: "digital_import"
expires_atStringaObbligatorio

Scadenza di questo caricamento o di questa importazione.

format: "date-time"
Esempio: "2026-11-03T13:00:00Z"
filenameStringaObbligatorio

File

Esempio: "codes.txt"
idStringaObbligatorio

Identificativo della risorsa; conservalo come restituito.

format: "uuid"
Esempio: "00000000-0000-4000-8000-000000000002"
product_idStringaObbligatorio

Identificativo del prodotto.

Esempio: "example"
purposeStringaObbligatorio

digital_import: TXT/CSV; digital_unit: file venduto singolarmente.

Vincoli
enum
["digital_unit", "digital_import"]
Esempio: "digital_import"
received_bytesInteroObbligatorio

Caricamento… · Dimensione in byte

Esempio: 18
sha256StringaObbligatorio

SHA-256 (hex, 64)

Esempio: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"
size_bytesInteroObbligatorio

Dimensione in byte

Esempio: 18
statusStringaObbligatorio

Stato accettato da questa specifica operazione.

Esempio: "ready"

Campi aggiuntivi: No

ImportCommit

ImportCommit · Crea una consegna prevista o ricevuta dal lotto convalidato. Una consegna prevista non è ancora vendibile.
delivered_atStringaObbligatorio

Data e ora di consegna.

format: "date-time"
Esempio: "2026-11-03T12:00:00Z"
expected_delivery_versionInteroObbligatorio

Versione della consegna; 0 per una nuova consegna.

minimum: 0maximum: 0
Esempio: 0
expected_sales_limit_versionIntero nullFacoltativo

Versione del limite di vendita; obbligatoria con publish_for_sale=true.

Intero:minimum: 0maximum: 9223372036854775807
Esempio: 0
expected_versionInteroObbligatorio

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

minimum: 1maximum: 9223372036854775807
Esempio: 2
location_idStringaObbligatorio

Identificativo dell’ubicazione nel magazzino.

Vincoli
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Esempio: "location-digital"
publish_for_saleBooleanoFacoltativo

true aumenta anche il limite finito di vendita; false lo lascia invariato.

Valore predefinito: falseEsempio: true
statusStringaObbligatorio

Stato accettato da questa specifica operazione.

Vincoli
enum
["planned", "received"]
Esempio: "received"
validation_digestStringaObbligatorio

Checksum della convalida; invialo senza modifiche alla conferma.

Vincoli
pattern
"^[0-9a-f]{64}$"
Esempio: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"
warehouse_idStringaObbligatorio

Identificativo del magazzino.

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

Campi aggiuntivi: No

ImportCreate

ImportCreate · Prepara una bozza con al massimo 1000 codici o 100 file. Le disponibilità in vendita non aumentano ancora.
countInteroObbligatorio

Numero esatto di unità nel lotto.

minimum: 1maximum: 1000
Esempio: 2
kindStringaObbligatorio

Forma della struttura dati, definita dai valori consentiti.

Vincoli
enum
["code", "file"]
Esempio: "code"

Campi aggiuntivi: No

ImportData

ImportData · Controlla stato, versione e convalida. La bozza appartiene alla chiave API che l’ha creata.
delivery_idStringa nullObbligatorio

ID della consegna o dell’assegnazione all’ordine.

Esempio: null
delivery_statusStringa nullObbligatorio

Stato della consegna: planned / received; null prima della conferma.

Esempio: null
delivery_versionIntero nullObbligatorio

Versione attuale della consegna al magazzino.

Esempio: null
expected_countInteroObbligatorio

Quantità prevista; viene accettato solo il lotto completo.

Esempio: 2
expires_atStringaObbligatorio

Scadenza di questo caricamento o di questa importazione.

format: "date-time"
Esempio: "2026-11-03T13:00:00Z"
idStringaObbligatorio

Identificativo della risorsa; conservalo come restituito.

format: "uuid"
Esempio: "00000000-0000-4000-8000-000000000001"
kindStringaObbligatorio

Forma della struttura dati, definita dai valori consentiti.

Vincoli
enum
["code", "file"]
Esempio: "code"
product_idStringaObbligatorio

Identificativo del prodotto.

Esempio: "example"
statusStringaObbligatorio

Stato accettato da questa specifica operazione.

Esempio: "validated"
validated_countInteroObbligatorio

Unità accettate nell’ultima convalida riuscita.

Esempio: 2
validation_digestStringa nullObbligatorio

Checksum della convalida; invialo senza modifiche alla conferma.

Esempio: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"
versionInteroObbligatorio

Versione della risorsa per il controllo della concorrenza.

Esempio: 2

Campi aggiuntivi: No

ImportReceive

ImportReceive · Ricevi le unità esistenti senza importare nuovamente codici o file.
expected_delivery_versionInteroObbligatorio

Versione della consegna; 0 per una nuova consegna.

minimum: 1maximum: 9223372036854775807
Esempio: 1
expected_sales_limit_versionIntero nullFacoltativo

Versione del limite di vendita; obbligatoria con publish_for_sale=true.

Intero:minimum: 0maximum: 9223372036854775807
expected_versionInteroObbligatorio

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

minimum: 1maximum: 9223372036854775807
Esempio: 3
publish_for_saleBooleanoFacoltativo

true aumenta anche il limite finito di vendita; false lo lascia invariato.

Valore predefinito: false

Campi aggiuntivi: No

ImportValidate

ImportValidate · Verifica l’intero lotto. Duplicati o voci non valide fanno rifiutare il lotto; i codici non vengono troncati.
code_columnStringa nullFacoltativo

Colonna CSV dei codici; usa code.

Stringa:const: "code"
expected_versionInteroObbligatorio

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

minimum: 1maximum: 9223372036854775807
Esempio: 1
formatStringa nullFacoltativo

Elenco codici: txt / csv; usa upload_ids per i file.

Vincoli · Stringa 1
enum
["txt", "csv"]
Esempio: "txt"
source_upload_idStringa nullFacoltativo

Caricamento privato TXT/CSV pronto di questa importazione.

Stringa:format: "uuid"
Esempio: "00000000-0000-4000-8000-000000000002"
upload_idsArray <Stringa> nullFacoltativo

1–100 caricamenti privati di file pronti di questa importazione.

Array:minItems: 1maxItems: 100
Array / Array:format: "uuid"

Campi aggiuntivi: No

ImportWithdrawal

ImportWithdrawal · Ritira solo le unità libere. Quelle riservate o assegnate restano collegate ai rispettivi ordini.
expected_delivery_versionInteroObbligatorio

Versione della consegna; 0 per una nuova consegna.

minimum: 1maximum: 9223372036854775807
Esempio: 1
expected_order_versionInteroObbligatorio

Versione dell’ordine di assegnazione, non dell’ordine cliente.

minimum: 0maximum: 9223372036854775807
Esempio: 1
expected_versionInteroObbligatorio

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

minimum: 1maximum: 9223372036854775807
Esempio: 3
reasonStringaObbligatorio

Motivo registrato per la modifica.

minLength: 1maxLength: 500
Esempio: "Withdraw a revoked license"

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

PoolChange

PoolChange · Attiva codici o file individuali da Professional. La disattivazione conserva gli accessi degli acquisti precedenti.
email_modeStringaFacoltativo

disabled: nessuna e-mail; order_link: link all’ordine; code_text: possibili codici aggiuntivi.

Vincoli
enum
["disabled", "order_link", "code_text"]
Valore predefinito: "disabled"Esempio: "order_link"
enabledBooleanoObbligatorio

Indica se questa impostazione è abilitata.

Esempio: true
expected_versionInteroObbligatorio

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

minimum: 0maximum: 9223372036854775807
Esempio: 0
retention_daysIntero nullFacoltativo

null: senza scadenza; 1–3650 giorni dal primo accesso. Nessuna eliminazione automatica dei codici.

Intero:minimum: 1maximum: 3650
Esempio: null

Campi aggiuntivi: No

PoolCounts

PoolCounts · Consulta impostazioni e quantità prima di modificarle. La risposta non contiene codici o file.
availableInteroObbligatorio

Numero di unità libere, non prenotate né assegnate.

Esempio: 1
heldInteroObbligatorio

Unità riservate agli ordini, non ancora consegnate.

Esempio: 0
issuedInteroObbligatorio

Unità già consegnate per acquisti pagati.

Esempio: 1
plannedInteroObbligatorio

Unità di consegne confermate ma non ancora ricevute.

Esempio: 0
retiredInteroObbligatorio

Unità ritirate conservate nella cronologia.

Esempio: 0
stagedInteroObbligatorio

Unità di importazioni incomplete, non ancora in scorta.

Esempio: 0

Campi aggiuntivi: No

PoolData

PoolData · Consulta impostazioni e quantità prima di modificarle. La risposta non contiene codici o file.
configuredBooleanoObbligatorio

Indica se le impostazioni della scorta sono salvate.

Esempio: true
countsPoolCounts Obbligatorio

Numero di unità per stato della scorta.

Esempio: {"available":1,"held":0,"issued":1,"planned":0,"retired":0,"staged":0}
email_modeStringaObbligatorio

disabled: nessuna e-mail; order_link: link all’ordine; code_text: possibili codici aggiuntivi.

Vincoli
enum
["disabled", "order_link", "code_text"]
Esempio: "order_link"
enabledBooleanoObbligatorio

Indica se questa impostazione è abilitata.

Esempio: true
order_versionInteroObbligatorio

Versione dell’ordine di assegnazione della scorta.

Esempio: 2
product_idStringaObbligatorio

Identificativo del prodotto.

Esempio: "example"
retention_daysIntero nullObbligatorio

null: senza scadenza; 1–3650 giorni dal primo accesso. Nessuna eliminazione automatica dei codici.

Esempio: null
versionInteroObbligatorio

Versione della risorsa per il controllo della concorrenza.

Esempio: 1

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

UnitData

UnitData · Leggi fino a 100 unità per pagina. L’elenco mostra i metadati senza rivelare i codici.
content_stateStringaObbligatorio

Stato del contenuto: present / deleting / deleted.

Esempio: "present"
delivery_idStringa nullObbligatorio

ID della consegna o dell’assegnazione all’ordine.

Esempio: "delivery-example"
filenameStringa nullObbligatorio

File

Esempio: null
idStringaObbligatorio

Identificativo della risorsa; conservalo come restituito.

format: "uuid"
Esempio: "00000000-0000-4000-8000-000000000003"
issued_atStringa nullObbligatorio

Prima consegna; null prima di essa.

Stringa:format: "date-time"
Esempio: null
kindStringaObbligatorio

Forma della struttura dati, definita dai valori consentiti.

Vincoli
enum
["file", "code"]
Esempio: "code"
location_idStringa nullObbligatorio

Identificativo dell’ubicazione nel magazzino.

Esempio: "location-digital"
mime_typeStringa nullObbligatorio

Tipo di contenuto del media.

Esempio: null
payload_idStringaObbligatorio

ID del contenuto, non un URL pubblico per il download.

format: "uuid"
Esempio: "00000000-0000-4000-8000-000000000004"
product_idStringaObbligatorio

Identificativo del prodotto.

Esempio: "example"
size_bytesIntero nullObbligatorio

Dimensione in byte

Esempio: null
sort_orderInteroObbligatorio

Posizione nella collezione ordinata.

Esempio: 1
stateStringaObbligatorio

Stato

Esempio: "available"
versionInteroObbligatorio

Versione della risorsa per il controllo della concorrenza.

Esempio: 1
warehouse_idStringa nullObbligatorio

Identificativo del magazzino.

Esempio: "warehouse-main"

Campi aggiuntivi: No

UnitDeletion

UnitDeletion · Ritira un codice o file invenduto indicando il motivo. Le unità riservate o assegnate sono escluse.
expected_versionInteroObbligatorio

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

minimum: 1
Esempio: 1
reasonStringaObbligatorio

Motivo registrato per la modifica.

minLength: 1maxLength: 500
Esempio: "Withdraw a revoked license"

Campi aggiuntivi: No

UnitReorder

UnitReorder · Invia tutta la pagina senza filtri nell’ordine desiderato. Una versione superata restituisce 409.
expected_order_versionInteroObbligatorio

Versione dell’ordine di assegnazione, non dell’ordine cliente.

minimum: 1
Esempio: 1
unit_idsArray <Stringa> Obbligatorio

Tutte le unità della pagina senza filtri nell’ordine desiderato.

minItems: 2maxItems: 100
Array:format: "uuid"
Esempio: ["00000000-0000-4000-8000-000000000008","00000000-0000-4000-8000-000000000003"]
window_cursorStringa nullFacoltativo

Cursore della pagina senza filtri; null per la prima.

Stringa:maxLength: 1024

Campi aggiuntivi: No

UnitReplacement

UnitReplacement · Sostituisci codice o file senza cambiarne la posizione. La modifica resta nella cronologia del magazzino.
codeStringa nullFacoltativo

Il codice digitale esatto. Mantieni maiuscole, minuscole e spazi interni.

Stringa:minLength: 1maxLength: 512
Esempio: "SYNTHETIC-REPLACEMENT"
expected_versionInteroObbligatorio

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

minimum: 1
Esempio: 1
reasonStringaObbligatorio

Motivo registrato per la modifica.

minLength: 1maxLength: 500
Esempio: "Replace an invalid activation code"
upload_idStringa nullFacoltativo

Identificativo della risorsa; conservalo come restituito. · upload_id

Stringa:format: "uuid"

Campi aggiuntivi: No

UnitsData

UnitsData · Leggi fino a 100 unità per pagina. L’elenco mostra i metadati senza rivelare i codici.
order_versionInteroObbligatorio

Versione dell’ordine di assegnazione della scorta.

Esempio: 2
totalInteroObbligatorio

Importo totale.

Esempio: 1
unitsArray <UnitData > Obbligatorio

Metadati delle unità; il contenuto richiede una richiesta autorizzata separata.

Esempio: [{"content_state":"present","delivery_id":"delivery-example","filename":null,"id":"00000000-0000-4000-8000-000000000003","issued_at":null,"kind":"code","location_id":"location-digital","mime_type":null,"payload_id":"00000000-0000-4000-8000-000000000004","product_id":"example","size_bytes":null,"sort_order":1,"state":"available","version":1,"warehouse_id":"warehouse-main"}]

Campi aggiuntivi: Sì