Schemi dei dati
Quantità assegnate alle ubicazioni del magazzino
AllocationData · Schema · Schemi dei dati: Scorte
location_codeStringaObbligatorioCodice dell’ubicazione nel magazzino.
location_idStringaObbligatorioIdentificativo dell’ubicazione nel magazzino.
location_nameStringaObbligatorioNome dell’ubicazione nel magazzino.
on_handInteroObbligatorioQuantità fisicamente presente.
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.
dataCodeContentDataObbligatorioContenuto di una risposta riuscita.
metaContextPageMetaContextMetaPageMetaRequestMetaObbligatorioMetadati della risposta.
Campi aggiuntivi: No
ApiResponse[DigitalUploadData]
ApiResponse_DigitalUploadData_ · Verifica dimensione, checksum e formato. Un caricamento pronto non equivale a una consegna ricevuta.
dataDigitalUploadDataObbligatorioContenuto di una risposta riuscita.
metaContextPageMetaContextMetaPageMetaRequestMetaObbligatorioMetadati della risposta.
Campi aggiuntivi: No
ApiResponse[ImportData]
ApiResponse_ImportData_ · Controlla stato, versione e convalida. La bozza appartiene alla chiave API che l’ha creata.
dataImportDataObbligatorioContenuto di una risposta riuscita.
metaContextPageMetaContextMetaPageMetaRequestMetaObbligatorioMetadati della risposta.
Campi aggiuntivi: No
Elenca · Giacenze — Scorte — Risposta
ApiResponse_list_StockData__ · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
dataArray <StockData> ObbligatorioEsempio di risposta · ApiResponse_list_StockData__.
metaContextPageMetaContextMetaPageMetaRequestMetaObbligatorioMetadati della risposta.
Campi aggiuntivi: No
ApiResponse[PoolData]
ApiResponse_PoolData_ · Consulta impostazioni e quantità prima di modificarle. La risposta non contiene codici o file.
dataPoolDataObbligatorioContenuto di una risposta riuscita.
metaContextPageMetaContextMetaPageMetaRequestMetaObbligatorioMetadati della risposta.
Campi aggiuntivi: No
Recupera · Giacenze — Scorte — Risposta
ApiResponse_StockDetailData_ · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
dataStockDetailDataObbligatorioEsempio di risposta · StockDetailData.
metaContextPageMetaContextMetaPageMetaRequestMetaObbligatorioMetadati della risposta.
Campi aggiuntivi: No
ApiResponse[UnitsData]
ApiResponse_UnitsData_ · Leggi fino a 100 unità per pagina. L’elenco mostra i metadati senza rivelare i codici.
dataUnitsDataObbligatorioContenuto di una risposta riuscita.
metaContextPageMetaContextMetaPageMetaRequestMetaObbligatorioMetadati della risposta.
Campi aggiuntivi: No
CodeContentData
CodeContentData · I codici vengono restituiti in JSON, i file come dati binari. Ogni richiesta richiede Bearer e il permesso reveal.
codeStringaObbligatorioIl codice digitale esatto. Mantieni maiuscole, minuscole e spazi interni.
minLength:1maxLength:512delivery_idStringa nullFacoltativoID della consegna o dell’assegnazione all’ordine.
Stringa:format:"uuid"kindStringaFacoltativoForma della struttura dati, definita dai valori consentiti.
const:"code"payload_idStringaObbligatorioID del contenuto, non un URL pubblico per il download.
format:"uuid"unit_idStringaObbligatorioID di un singolo codice o file.
format:"uuid"
Campi aggiuntivi: No
DigitalUploadCreate
DigitalUploadCreate · Riserva spazio per un file e collegalo a un’importazione o all’unità da sostituire.
consumer_idStringaObbligatorioID dell’importazione o dell’unità associata.
format:"uuid"consumer_kindStringaObbligatorioDestinazione del caricamento: digital_import / digital_unit.
Vincoli
enum["digital_import", "digital_unit"]
filenameStringaObbligatorioFile
minLength:1maxLength:255purposeStringaObbligatoriodigital_import: TXT/CSV; digital_unit: file venduto singolarmente.
Vincoli
enum["digital_unit", "digital_import"]
sha256StringaObbligatorioSHA-256 (hex, 64)
Vincoli
pattern"^[0-9a-f]{64}$"
size_bytesInteroObbligatorioDimensione in byte
minimum:1maximum:262144000
Campi aggiuntivi: No
DigitalUploadData
DigitalUploadData · Verifica dimensione, checksum e formato. Un caricamento pronto non equivale a una consegna ricevuta.
consumer_idStringaObbligatorioID dell’importazione o dell’unità associata.
format:"uuid"consumer_kindStringaObbligatorioDestinazione del caricamento: digital_import / digital_unit.
Vincoli
enum["digital_import", "digital_unit"]
expires_atStringaObbligatorioScadenza di questo caricamento o di questa importazione.
format:"date-time"filenameStringaObbligatorioFile
idStringaObbligatorioIdentificativo della risorsa; conservalo come restituito.
format:"uuid"product_idStringaObbligatorioIdentificativo del prodotto.
purposeStringaObbligatoriodigital_import: TXT/CSV; digital_unit: file venduto singolarmente.
Vincoli
enum["digital_unit", "digital_import"]
received_bytesInteroObbligatorioCaricamento… · Dimensione in byte
sha256StringaObbligatorioSHA-256 (hex, 64)
size_bytesInteroObbligatorioDimensione in byte
statusStringaObbligatorioStato accettato da questa specifica operazione.
Campi aggiuntivi: No
ImportCommit
ImportCommit · Crea una consegna prevista o ricevuta dal lotto convalidato. Una consegna prevista non è ancora vendibile.
delivered_atStringaObbligatorioData e ora di consegna.
format:"date-time"expected_delivery_versionInteroObbligatorioVersione della consegna; 0 per una nuova consegna.
minimum:0maximum:0expected_sales_limit_versionIntero nullFacoltativoVersione del limite di vendita; obbligatoria con publish_for_sale=true.
Intero:minimum:0maximum:9223372036854775807expected_versionInteroObbligatorioVersione letta prima della scrittura; una differenza impedisce l’aggiornamento.
minimum:1maximum:9223372036854775807location_idStringaObbligatorioIdentificativo dell’ubicazione nel magazzino.
Vincoli
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
publish_for_saleBooleanoFacoltativotrue aumenta anche il limite finito di vendita; false lo lascia invariato.
statusStringaObbligatorioStato accettato da questa specifica operazione.
Vincoli
enum["planned", "received"]
validation_digestStringaObbligatorioChecksum della convalida; invialo senza modifiche alla conferma.
Vincoli
pattern"^[0-9a-f]{64}$"
warehouse_idStringaObbligatorioIdentificativo del magazzino.
Vincoli
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
Campi aggiuntivi: No
ImportCreate
ImportCreate · Prepara una bozza con al massimo 1000 codici o 100 file. Le disponibilità in vendita non aumentano ancora.
countInteroObbligatorioNumero esatto di unità nel lotto.
minimum:1maximum:1000kindStringaObbligatorioForma della struttura dati, definita dai valori consentiti.
Vincoli
enum["code", "file"]
Campi aggiuntivi: No
ImportData
ImportData · Controlla stato, versione e convalida. La bozza appartiene alla chiave API che l’ha creata.
delivery_idStringa nullObbligatorioID della consegna o dell’assegnazione all’ordine.
delivery_statusStringa nullObbligatorioStato della consegna: planned / received; null prima della conferma.
delivery_versionIntero nullObbligatorioVersione attuale della consegna al magazzino.
expected_countInteroObbligatorioQuantità prevista; viene accettato solo il lotto completo.
expires_atStringaObbligatorioScadenza di questo caricamento o di questa importazione.
format:"date-time"idStringaObbligatorioIdentificativo della risorsa; conservalo come restituito.
format:"uuid"kindStringaObbligatorioForma della struttura dati, definita dai valori consentiti.
Vincoli
enum["code", "file"]
product_idStringaObbligatorioIdentificativo del prodotto.
statusStringaObbligatorioStato accettato da questa specifica operazione.
validated_countInteroObbligatorioUnità accettate nell’ultima convalida riuscita.
validation_digestStringa nullObbligatorioChecksum della convalida; invialo senza modifiche alla conferma.
versionInteroObbligatorioVersione della risorsa per il controllo della concorrenza.
Campi aggiuntivi: No
ImportReceive
ImportReceive · Ricevi le unità esistenti senza importare nuovamente codici o file.
expected_delivery_versionInteroObbligatorioVersione della consegna; 0 per una nuova consegna.
minimum:1maximum:9223372036854775807expected_sales_limit_versionIntero nullFacoltativoVersione del limite di vendita; obbligatoria con publish_for_sale=true.
Intero:minimum:0maximum:9223372036854775807expected_versionInteroObbligatorioVersione letta prima della scrittura; una differenza impedisce l’aggiornamento.
minimum:1maximum:9223372036854775807publish_for_saleBooleanoFacoltativotrue aumenta anche il limite finito di vendita; false lo lascia invariato.
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 nullFacoltativoColonna CSV dei codici; usa code.
Stringa:const:"code"expected_versionInteroObbligatorioVersione letta prima della scrittura; una differenza impedisce l’aggiornamento.
minimum:1maximum:9223372036854775807formatStringa nullFacoltativoElenco codici: txt / csv; usa upload_ids per i file.
Vincoli · Stringa 1
enum["txt", "csv"]
source_upload_idStringa nullFacoltativoCaricamento privato TXT/CSV pronto di questa importazione.
Stringa:format:"uuid"upload_idsArray <Stringa> nullFacoltativo1–100 caricamenti privati di file pronti di questa importazione.
Array:minItems:1maxItems:100Array / Array:format:"uuid"
Campi aggiuntivi: No
ImportWithdrawal
ImportWithdrawal · Ritira solo le unità libere. Quelle riservate o assegnate restano collegate ai rispettivi ordini.
expected_delivery_versionInteroObbligatorioVersione della consegna; 0 per una nuova consegna.
minimum:1maximum:9223372036854775807expected_order_versionInteroObbligatorioVersione dell’ordine di assegnazione, non dell’ordine cliente.
minimum:0maximum:9223372036854775807expected_versionInteroObbligatorioVersione letta prima della scrittura; una differenza impedisce l’aggiornamento.
minimum:1maximum:9223372036854775807reasonStringaObbligatorioMotivo registrato per la modifica.
minLength:1maxLength:500
Campi aggiuntivi: No
Aggiorna · Prenotazione manuale — Scorte — Corpo della richiesta
ManualReservationUpdate · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
expected_versionInteroObbligatorioVersione letta prima della scrittura; una differenza impedisce l’aggiornamento.
minimum:1maximum:9223372036854775807manual_reservedInteroObbligatorioQuantità prenotata manualmente.
minimum:0maximum:2147483647reasonStringaFacoltativoMotivo registrato per la modifica.
maxLength:500
Campi aggiuntivi: No
PoolChange
PoolChange · Attiva codici o file individuali da Professional. La disattivazione conserva gli accessi degli acquisti precedenti.
email_modeStringaFacoltativodisabled: nessuna e-mail; order_link: link all’ordine; code_text: possibili codici aggiuntivi.
Vincoli
enum["disabled", "order_link", "code_text"]
enabledBooleanoObbligatorioIndica se questa impostazione è abilitata.
expected_versionInteroObbligatorioVersione letta prima della scrittura; una differenza impedisce l’aggiornamento.
minimum:0maximum:9223372036854775807retention_daysIntero nullFacoltativonull: senza scadenza; 1–3650 giorni dal primo accesso. Nessuna eliminazione automatica dei codici.
Intero:minimum:1maximum:3650
Campi aggiuntivi: No
PoolCounts
PoolCounts · Consulta impostazioni e quantità prima di modificarle. La risposta non contiene codici o file.
availableInteroObbligatorioNumero di unità libere, non prenotate né assegnate.
heldInteroObbligatorioUnità riservate agli ordini, non ancora consegnate.
issuedInteroObbligatorioUnità già consegnate per acquisti pagati.
plannedInteroObbligatorioUnità di consegne confermate ma non ancora ricevute.
retiredInteroObbligatorioUnità ritirate conservate nella cronologia.
stagedInteroObbligatorioUnità di importazioni incomplete, non ancora in scorta.
Campi aggiuntivi: No
PoolData
PoolData · Consulta impostazioni e quantità prima di modificarle. La risposta non contiene codici o file.
configuredBooleanoObbligatorioIndica se le impostazioni della scorta sono salvate.
countsPoolCountsObbligatorioNumero di unità per stato della scorta.
email_modeStringaObbligatoriodisabled: nessuna e-mail; order_link: link all’ordine; code_text: possibili codici aggiuntivi.
Vincoli
enum["disabled", "order_link", "code_text"]
enabledBooleanoObbligatorioIndica se questa impostazione è abilitata.
order_versionInteroObbligatorioVersione dell’ordine di assegnazione della scorta.
product_idStringaObbligatorioIdentificativo del prodotto.
retention_daysIntero nullObbligatorionull: senza scadenza; 1–3650 giorni dal primo accesso. Nessuna eliminazione automatica dei codici.
versionInteroObbligatorioVersione della risorsa per il controllo della concorrenza.
Campi aggiuntivi: No
Aggiorna · Limite di vendita — Scorte — Corpo della richiesta
SalesLimitUpdate · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
expected_versionInteroObbligatorioVersione letta prima della scrittura; una differenza impedisce l’aggiornamento.
minimum:1maximum:9223372036854775807reasonStringaFacoltativoMotivo registrato per la modifica.
maxLength:500sellable_limitInteroObbligatorioLimite di vendita: -1 indica assenza di limite e 0 disabilita la disponibilità alla vendita.
minimum:-1maximum:2147483647
Campi aggiuntivi: No
Crea · Rettifica delle giacenze — Scorte — Corpo della richiesta
StockAdjustmentCreate · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
expected_versionInteroObbligatorioVersione letta prima della scrittura; una differenza impedisce l’aggiornamento.
minimum:0maximum:9223372036854775807locationsArray <LocationQuantity> ObbligatorioUbicazioni del magazzino.
minItems:1maxItems:100reasonStringaObbligatorioMotivo registrato per la modifica.
minLength:1maxLength:500target_idStringaObbligatorioIdentificativo del prodotto o della variante interessati dall’operazione.
Vincoli
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
target_typeStringaObbligatorioIndica se l’operazione riguarda un prodotto o una variante.
Vincoli
enum["product", "variant"]
warehouse_idStringaObbligatorioIdentificativo del magazzino.
Vincoli
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
Campi aggiuntivi: No
Aggiorna · Giacenze — Scorte — Corpo della richiesta
StockAdjustmentUpdate · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
expected_versionInteroObbligatorioVersione letta prima della scrittura; una differenza impedisce l’aggiornamento.
minimum:1maximum:9223372036854775807locationsArray <LocationQuantity> ObbligatorioUbicazioni del magazzino.
minItems:1maxItems:100reasonStringaObbligatorioMotivo registrato per la modifica.
minLength:1maxLength:500
Campi aggiuntivi: No
Elenca · Giacenze — Scorte — Risposta
StockData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
activeBooleanoObbligatorioIndica se la risorsa è attiva.
availableIntero nullObbligatorioQuantità disponibile alla vendita; null indica una quantità illimitata.
idStringaObbligatorioIdentificativo della risorsa; conservalo come restituito. (StockData).
manual_reservedInteroObbligatorioQuantità prenotata manualmente.
on_handInteroObbligatorioQuantità fisicamente presente.
reservedInteroObbligatorioQuantità prenotata dagli ordini.
sellable_limitInteroObbligatorioLimite di vendita: -1 indica assenza di limite e 0 disabilita la disponibilità alla vendita.
target_idStringaObbligatorioIdentificativo del prodotto o della variante interessati dall’operazione.
target_typeStringaObbligatorioIndica se l’operazione riguarda un prodotto o una variante.
Vincoli
enum["product", "variant"]
total_reservedInteroObbligatorioQuantità totale prenotata.
updated_atStringaObbligatorioData e ora dell’aggiornamento più recente.
format:"date-time"versionInteroObbligatorioVersione della risorsa per il controllo della concorrenza.
warehouse_idStringaObbligatorioIdentificativo del magazzino.
Campi aggiuntivi: No
Recupera · Giacenze — Scorte — Risposta
StockDetailData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
activeBooleanoObbligatorioIndica se la risorsa è attiva.
allocationsArray <AllocationData> ObbligatorioQuantità assegnate alle ubicazioni del magazzino.
availableIntero nullObbligatorioQuantità disponibile alla vendita; null indica una quantità illimitata.
idStringaObbligatorioIdentificativo della risorsa; conservalo come restituito. (StockDetailData).
manual_reservedInteroObbligatorioQuantità prenotata manualmente.
on_handInteroObbligatorioQuantità fisicamente presente.
reservedInteroObbligatorioQuantità prenotata dagli ordini.
sellable_limitInteroObbligatorioLimite di vendita: -1 indica assenza di limite e 0 disabilita la disponibilità alla vendita.
target_idStringaObbligatorioIdentificativo del prodotto o della variante interessati dall’operazione.
target_typeStringaObbligatorioIndica se l’operazione riguarda un prodotto o una variante.
Vincoli
enum["product", "variant"]
total_reservedInteroObbligatorioQuantità totale prenotata.
updated_atStringaObbligatorioData e ora dell’aggiornamento più recente.
format:"date-time"versionInteroObbligatorioVersione della risorsa per il controllo della concorrenza.
warehouse_idStringaObbligatorioIdentificativo del magazzino.
Campi aggiuntivi: No
UnitData
UnitData · Leggi fino a 100 unità per pagina. L’elenco mostra i metadati senza rivelare i codici.
content_stateStringaObbligatorioStato del contenuto: present / deleting / deleted.
delivery_idStringa nullObbligatorioID della consegna o dell’assegnazione all’ordine.
filenameStringa nullObbligatorioFile
idStringaObbligatorioIdentificativo della risorsa; conservalo come restituito.
format:"uuid"issued_atStringa nullObbligatorioPrima consegna; null prima di essa.
Stringa:format:"date-time"kindStringaObbligatorioForma della struttura dati, definita dai valori consentiti.
Vincoli
enum["file", "code"]
location_idStringa nullObbligatorioIdentificativo dell’ubicazione nel magazzino.
mime_typeStringa nullObbligatorioTipo di contenuto del media.
payload_idStringaObbligatorioID del contenuto, non un URL pubblico per il download.
format:"uuid"product_idStringaObbligatorioIdentificativo del prodotto.
size_bytesIntero nullObbligatorioDimensione in byte
sort_orderInteroObbligatorioPosizione nella collezione ordinata.
stateStringaObbligatorioStato
versionInteroObbligatorioVersione della risorsa per il controllo della concorrenza.
warehouse_idStringa nullObbligatorioIdentificativo del magazzino.
Campi aggiuntivi: No
UnitDeletion
UnitDeletion · Ritira un codice o file invenduto indicando il motivo. Le unità riservate o assegnate sono escluse.
expected_versionInteroObbligatorioVersione letta prima della scrittura; una differenza impedisce l’aggiornamento.
minimum:1reasonStringaObbligatorioMotivo registrato per la modifica.
minLength:1maxLength:500
Campi aggiuntivi: No
UnitReorder
UnitReorder · Invia tutta la pagina senza filtri nell’ordine desiderato. Una versione superata restituisce 409.
expected_order_versionInteroObbligatorioVersione dell’ordine di assegnazione, non dell’ordine cliente.
minimum:1unit_idsArray <Stringa> ObbligatorioTutte le unità della pagina senza filtri nell’ordine desiderato.
minItems:2maxItems:100Array:format:"uuid"window_cursorStringa nullFacoltativoCursore 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 nullFacoltativoIl codice digitale esatto. Mantieni maiuscole, minuscole e spazi interni.
Stringa:minLength:1maxLength:512expected_versionInteroObbligatorioVersione letta prima della scrittura; una differenza impedisce l’aggiornamento.
minimum:1reasonStringaObbligatorioMotivo registrato per la modifica.
minLength:1maxLength:500upload_idStringa nullFacoltativoIdentificativo 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_versionInteroObbligatorioVersione dell’ordine di assegnazione della scorta.
totalInteroObbligatorioImporto totale.
unitsArray <UnitData> ObbligatorioMetadati delle unità; il contenuto richiede una richiesta autorizzata separata.
Campi aggiuntivi: Sì