Vai al contenuto
ShopentlyLearn

Schemi dei dati: Prodotti

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

Schemi dei dati

ApiResponse_ProductFileListData_

ApiResponse_ProductFileListData_ · Campi, tipi e vincoli dei dati accettati o restituiti dall’API. Invia i file come multipart/form-data dopo aver creato upload_id, poi associali al prodotto. Il download richiede un token Bearer e il permesso per category; la risposta contiene i byte, senza indirizzo pubblico né password. Per mode=period scegli days (1–3650) oppure il precedente months, mai entrambi. Le condizioni vengono memorizzate all’acquisto; il rimborso revoca l’accesso solo alla riga rimborsata.
dataProductFileListData Obbligatorio

Contenuto di una risposta riuscita.

Esempio: {"files":[{"category":"digital","created_at":"2026-01-01T12:00:00Z","current_version_id":"00000000-0000-4000-8000-000000000001","file_id":"00000000-0000-4000-8000-000000000001","filename":"manual.pdf","id":"00000000-0000-4000-8000-000000000001","label":"Manual","mime_type":"application/pdf","sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"state":"active","version_number":1}],"product_version":2}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorio

Metadati della risposta.

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

Campi aggiuntivi: No

ApiResponse_ReleaseListData_

ApiResponse_ReleaseListData_ · Campi, tipi e vincoli dei dati accettati o restituiti dall’API. Invia i file come multipart/form-data dopo aver creato upload_id, poi associali al prodotto. Il download richiede un token Bearer e il permesso per category; la risposta contiene i byte, senza indirizzo pubblico né password. Per mode=period scegli days (1–3650) oppure il precedente months, mai entrambi. Le condizioni vengono memorizzate all’acquisto; il rimborso revoca l’accesso solo alla riga rimborsata.
dataReleaseListData Obbligatorio

Contenuto di una risposta riuscita.

Esempio: {"current_release_id":"00000000-0000-4000-8000-000000000001","product_version":2,"releases":[{"changelog":"Manual update","files":[{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}],"id":"00000000-0000-4000-8000-000000000001","manifest_sha256":"1111111111111111111111111111111111111111111111111111111111111111","published_at":null,"release_sequence":null,"state":"active","version_label":"1.0","withdrawn_at":null}],"update_days":365,"update_mode":"period","update_months":null}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorio

Metadati della risposta.

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

Campi aggiuntivi: No

ApiResponse_UploadData_

ApiResponse_UploadData_ · Campi, tipi e vincoli dei dati accettati o restituiti dall’API. Invia i file come multipart/form-data dopo aver creato upload_id, poi associali al prodotto. Il download richiede un token Bearer e il permesso per category; la risposta contiene i byte, senza indirizzo pubblico né password. Per mode=period scegli days (1–3650) oppure il precedente months, mai entrambi. Le condizioni vengono memorizzate all’acquisto; il rimborso revoca l’accesso solo alla riga rimborsata.
dataUploadData Obbligatorio

Contenuto di una risposta riuscita.

Esempio: {"category":"digital","expires_at":"2026-01-01T12:00:00Z","filename":"manual.pdf","id":"00000000-0000-4000-8000-000000000001","product_id":"example","received_bytes":46,"sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"status":"ready"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorio

Metadati della risposta.

Esempio: {"request_id":"example"}

Campi aggiuntivi: No

ApiResponse[AudienceData]

ApiResponse_AudienceData_ · Consulta la regola di accesso e la versione del prodotto. La prima pubblicazione resta il riferimento temporale.
dataAudienceData Obbligatorio

Contenuto di una risposta riuscita.

Esempio: {"anchor_at":"2026-11-03T12:00:00Z","effective_at":"2026-11-03T12:00:00Z","file_id":"00000000-0000-4000-8000-000000000007","file_version_id":"00000000-0000-4000-8000-000000000010","historical_access_preserved":true,"id":"00000000-0000-4000-8000-000000000009","lookback_days":null,"mode":"all_purchasers","next_cursor":null,"order_ids":[],"product_version":3,"revision":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorio

Metadati della risposta.

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

Campi aggiuntivi: No

Elenca — Prodotti — Risposta

ApiResponse_list_ProductSummaryData__ · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
dataArray <ProductSummaryData > Obbligatorio

Esempio di risposta · ApiResponse_list_ProductSummaryData__.

Esempio: [{"availability":{"available_from":null,"available_until":null,"is_available":true},"brand_id":null,"condition":"new","created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"price_version":1,"primary_category_id":"example","primary_media_id":"example","published":false,"sku":"example","slug":"example","tax_category_id":"example","updated_at":"2026-01-01T12:00:00Z","variants_enabled":false,"version":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorio

Metadati della risposta.

Esempio: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Campi aggiuntivi: No

Recupera — Prodotti — Risposta

ApiResponse_ProductDetailData_ · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
dataProductDetailData Obbligatorio

Esempio di risposta · ProductDetailData.

Esempio: {"availability":{"available_from":null,"available_until":null,"is_available":true},"brand_id":null,"condition":"new","created_at":"2026-01-01T12:00:00Z","description":"example","features":[{"feature_id":"example","feature_name":"example","value":"example","value_id":"example"}],"id":"example","identifiers":{},"media":[{"alt_text":"example","id":"example","is_primary":true,"kind":"image","mime_type":"image/jpeg","position":1,"url":"https://example.invalid/product.jpg"}],"meta_description":"example","meta_keywords":["example"],"meta_title":"example","name":"Example","number":"example","price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"price_version":1,"primary_category_id":"example","primary_media_id":"example","published":false,"sku":"example","slug":"example","tax_category_id":"example","updated_at":"2026-01-01T12:00:00Z","variants_enabled":false,"version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorio

Metadati della risposta.

Esempio: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Campi aggiuntivi: No

AudienceChange

AudienceChange · Scegli gli acquisti idonei. Gli ordini selezionati devono contenere questo prodotto pagato e non rimborsato.
audienceAudienceSelection Obbligatorio

Regola esplicita di accesso al file condiviso.

Esempio: {"mode":"all_purchasers"}
expected_versionInteroObbligatorio

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

minimum: 1maximum: 9223372036854775807
Esempio: 1

Campi aggiuntivi: No

AudienceData

AudienceData · Consulta la regola di accesso e la versione del prodotto. La prima pubblicazione resta il riferimento temporale.
anchor_atStringaObbligatorio

Prima pubblicazione; non cambia modificando la regola.

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

Data di pubblicazione di questa regola di accesso.

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

Identificativo della risorsa; conservalo come restituito. · file_id

Esempio: "00000000-0000-4000-8000-000000000007"
file_version_idStringaObbligatorio

ID di una versione immutabile del file.

Esempio: "00000000-0000-4000-8000-000000000010"
historical_access_preservedBooleanoFacoltativo

I diritti già concessi restano quando la regola viene ristretta.

Valore predefinito: trueEsempio: true
idStringaObbligatorio

Identificativo della risorsa; conservalo come restituito.

Esempio: "00000000-0000-4000-8000-000000000009"
lookback_daysIntero nullObbligatorio

1–3650 giorni prima della prima pubblicazione; solo recent_and_new.

Esempio: null
modeStringaObbligatorio

Regola esplicita di accesso al file condiviso. new_purchases / recent_and_new / selected / all_purchasers.

Esempio: "all_purchasers"
next_cursorStringa nullObbligatorio

Valore di continuazione per la pagina successiva, oppure null.

Esempio: null
order_idsArray <Stringa> Obbligatorio

Ordini pagati e non rimborsati che contengono questo prodotto.

Esempio: []
product_versionInteroObbligatorio

Versione corrente del prodotto per il controllo della concorrenza.

Esempio: 3
revisionInteroObbligatorio

Revisione progressiva della regola di accesso.

Esempio: 1

Campi aggiuntivi: No

AudienceSelection

AudienceSelection · Scegli gli acquisti idonei. Gli ordini selezionati devono contenere questo prodotto pagato e non rimborsato.
lookback_daysIntero nullFacoltativo

1–3650 giorni prima della prima pubblicazione; solo recent_and_new.

Intero:minimum: 1maximum: 3650
modeStringaObbligatorio

Regola esplicita di accesso al file condiviso. new_purchases / recent_and_new / selected / all_purchasers.

Vincoli
enum
["new_purchases", "recent_and_new", "selected", "all_purchasers"]
Esempio: "new_purchases"
order_idsArray <Stringa> Facoltativo

Ordini pagati e non rimborsati che contengono questo prodotto.

maxItems: 1000
Vincoli · Array 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Valore predefinito: []

Campi aggiuntivi: No

Informazioni sulla disponibilità nel contesto selezionato

AvailabilityData · Schema · Schemi dei dati: Prodotti
available_fromStringa nullObbligatorio

Inizio della disponibilità.

Stringa:format: "date-time"
Esempio: null
available_untilStringa nullObbligatorio

Fine della disponibilità.

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

Indica se l’elemento è disponibile in questo contesto.

Esempio: true

Campi aggiuntivi: No

FileAssign

FileAssign · Campi, tipi e vincoli dei dati accettati o restituiti dall’API. Invia i file come multipart/form-data dopo aver creato upload_id, poi associali al prodotto. Il download richiede un token Bearer e il permesso per category; la risposta contiene i byte, senza indirizzo pubblico né password. Per mode=period scegli days (1–3650) oppure il precedente months, mai entrambi. Le condizioni vengono memorizzate all’acquisto; il rimborso revoca l’accesso solo alla riga rimborsata.
audienceAudienceSelection nullFacoltativo

Regola esplicita di accesso al file condiviso.

Esempio: {"mode":"new_purchases"}
expected_versionInteroObbligatorio

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

minimum: 1maximum: 9223372036854775807
Esempio: 1
labelStringaFacoltativo

Nome della risorsa nel contesto pertinente.

maxLength: 300
Valore predefinito: ""
upload_idStringaObbligatorio

Identificativo della risorsa; conservalo come restituito. · upload_id

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

Campi aggiuntivi: No

FileCategory

FileCategory · Campi, tipi e vincoli dei dati accettati o restituiti dall’API. Invia i file come multipart/form-data dopo aver creato upload_id, poi associali al prodotto. Il download richiede un token Bearer e il permesso per category; la risposta contiene i byte, senza indirizzo pubblico né password. Per mode=period scegli days (1–3650) oppure il precedente months, mai entrambi. Le condizioni vengono memorizzate all’acquisto; il rimborso revoca l’accesso solo alla riga rimborsata.
Stringa
Vincoli
enum
["internal", "customer_document", "digital"]

Campi aggiuntivi: Sì

Informazioni sul prezzo nel contesto selezionato

PriceData · Schema · Schemi dei dati: Prodotti
amountStringaObbligatorio

Importo decimale codificato come stringa JSON; null solo dove consentito.

Esempio: "0.00"
currencyStringaObbligatorio

Codice della valuta dell’importo.

Vincoli
pattern
"^[A-Z]{3}$"
Esempio: "PLN"
minor_unitsInteroObbligatorio

Numero di cifre decimali usate dalla valuta.

minimum: 0maximum: 4
Esempio: 2
tax_includedBooleanoObbligatorio

Indica se il prezzo inviato include le imposte.

Esempio: true

Campi aggiuntivi: No

Informazioni sul listino

PriceListData · Schema · Schemi dei dati: Prodotti
currencyStringaObbligatorio

Codice della valuta dell’importo.

idStringaObbligatorio

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

tax_includedBooleanoObbligatorio

Indica se il prezzo inviato include le imposte.

versionInteroObbligatorio

Versione della risorsa per il controllo della concorrenza.

Campi aggiuntivi: No

Crea — Prodotti — Corpo della richiesta

ProductCreate · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
brand_idStringa nullFacoltativo

Identificativo del marchio.

Stringa:minLength: 1maxLength: 63
conditionStringaFacoltativo

Condizione del prodotto.

Vincoli
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Valore predefinito: "new"
descriptionStringa nullFacoltativo

Descrizione nella lingua selezionata.

Stringa:maxLength: 100000
feature_value_idsArray <Stringa> Facoltativo

Identificativi dei valori selezionati per le caratteristiche.

maxItems: 1000
Array:minLength: 1maxLength: 63
identifiersProductIdentifiers nullFacoltativo

Codici identificativi del prodotto.

market_idsArray <Stringa> Facoltativo

Identificativi dei mercati selezionati.

maxItems: 1000
Array:minLength: 1maxLength: 63
media_idsArray <Stringa> Facoltativo

Identificativi di media già esistenti.

maxItems: 30
Array:minLength: 1maxLength: 63
meta_descriptionStringa nullFacoltativo

Descrizione per i motori di ricerca nella lingua selezionata.

Stringa:maxLength: 160
meta_keywordsArray <Stringa> nullFacoltativo

Parole chiave per i motori di ricerca nella lingua selezionata.

Array:maxItems: 20
Array / Array:maxLength: 50
meta_titleStringa nullFacoltativo

Titolo per i motori di ricerca nella lingua selezionata.

Stringa:maxLength: 70
nameStringaObbligatorio

Nome della risorsa nel contesto pertinente.

minLength: 1maxLength: 300
Esempio: "Example"
pricingProductPrice Facoltativo

Configurazione dei prezzi e relative versioni di concorrenza.

primary_category_idStringa nullFacoltativo

Identificativo della categoria principale.

Stringa:minLength: 1maxLength: 63
publishedBooleanoFacoltativo

Indica se la risorsa è pubblicata.

Valore predefinito: false
skuStringaObbligatorio

Codice di identificazione dell’articolo a magazzino.

minLength: 1maxLength: 100
Vincoli
pattern
"^\\S+$"
Esempio: "example"
slugStringa nullFacoltativo

Segmento del percorso URL nella lingua selezionata.

Stringa:maxLength: 160
tax_category_idStringa nullFacoltativo

Identificativo della categoria fiscale.

Stringa:minLength: 1maxLength: 63
variant_value_idsArray <Stringa> Facoltativo

Identificativi dei valori selezionati per la variante.

maxItems: 250
Array:minLength: 1maxLength: 63
variants_enabledBooleanoFacoltativo

Indica se il prodotto utilizza varianti.

Valore predefinito: false

Campi aggiuntivi: No

Recupera — Prodotti — Risposta

ProductDetailData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
availabilityAvailabilityData Obbligatorio

Informazioni sulla disponibilità nel contesto selezionato.

Esempio: {"available_from":null,"available_until":null,"is_available":true}
brand_idStringa nullObbligatorio

Identificativo del marchio.

Esempio: null
conditionStringaObbligatorio

Condizione del prodotto.

Vincoli
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Esempio: "new"
created_atStringaObbligatorio

Data e ora di creazione.

format: "date-time"
Esempio: "2026-01-01T12:00:00Z"
descriptionStringa nullObbligatorio

Descrizione nella lingua selezionata.

Esempio: "example"
featuresArray <FeatureSelectionData > Obbligatorio

Caratteristiche del prodotto.

Esempio: [{"feature_id":"example","feature_name":"example","value":"example","value_id":"example"}]
idStringaObbligatorio

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

Esempio: "example"
identifiersOggettoCampi aggiuntivi: StringaObbligatorio

Codici identificativi del prodotto.

Esempio: {}
mediaArray <ProductMediaData > Obbligatorio

Informazioni sui media allegati.

Esempio: [{"alt_text":"example","id":"example","is_primary":true,"kind":"image","mime_type":"image/jpeg","position":1,"url":"https://example.invalid/product.jpg"}]
meta_descriptionStringa nullObbligatorio

Descrizione per i motori di ricerca nella lingua selezionata.

Esempio: "example"
meta_keywordsArray <Stringa> nullObbligatorio

Parole chiave per i motori di ricerca nella lingua selezionata.

Esempio: ["example"]
meta_titleStringa nullObbligatorio

Titolo per i motori di ricerca nella lingua selezionata.

Esempio: "example"
nameStringa nullObbligatorio

Nome della risorsa nel contesto pertinente.

Esempio: "Example"
numberStringaObbligatorio

Numero dell’ordine o della richiesta destinato alle persone.

Esempio: "example"
pricePriceData nullObbligatorio

Informazioni sul prezzo nel contesto selezionato.

Esempio: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
price_versionInteroObbligatorio

Versione corrente del prezzo per il controllo della concorrenza.

Esempio: 1
primary_category_idStringa nullObbligatorio

Identificativo della categoria principale.

Esempio: "example"
primary_media_idStringa nullObbligatorio

Identificativo del media principale.

Esempio: "example"
publishedBooleanoObbligatorio

Indica se la risorsa è pubblicata.

Esempio: false
skuStringaObbligatorio

Codice di identificazione dell’articolo a magazzino.

Esempio: "example"
slugStringa nullObbligatorio

Segmento del percorso URL nella lingua selezionata.

Esempio: "example"
tax_category_idStringaObbligatorio

Identificativo della categoria fiscale.

Esempio: "example"
updated_atStringaObbligatorio

Data e ora dell’aggiornamento più recente.

format: "date-time"
Esempio: "2026-01-01T12:00:00Z"
variants_enabledBooleanoObbligatorio

Indica se il prodotto utilizza varianti.

Esempio: false
versionInteroObbligatorio

Versione della risorsa per il controllo della concorrenza.

Esempio: 1

Campi aggiuntivi: No

ProductFileData

ProductFileData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API. Invia i file come multipart/form-data dopo aver creato upload_id, poi associali al prodotto. Il download richiede un token Bearer e il permesso per category; la risposta contiene i byte, senza indirizzo pubblico né password. Per mode=period scegli days (1–3650) oppure il precedente months, mai entrambi. Le condizioni vengono memorizzate all’acquisto; il rimborso revoca l’accesso solo alla riga rimborsata.
categoryFileCategory Obbligatorio

Categoria del file: internal / customer_document / digital

Esempio: "digital"
created_atStringaObbligatorio

Data e ora di creazione.

format: "date-time"
Esempio: "2026-01-01T12:00:00Z"
current_version_idStringaObbligatorio

Identificativo della risorsa; conservalo come restituito. · current_version_id

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

Identificativo della risorsa; conservalo come restituito. · file_id

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

File

Esempio: "manual.pdf"
idStringaObbligatorio

Identificativo della risorsa; conservalo come restituito.

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

Nome della risorsa nel contesto pertinente.

Esempio: "Manual"
mime_typeStringaObbligatorio

Tipo di contenuto del media.

Esempio: "application/pdf"
sha256StringaObbligatorio

SHA-256 (hex, 64)

Esempio: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesInteroObbligatorio

Dimensione in byte

Esempio: 46
stateStringaObbligatorio

Stato

Esempio: "active"
version_numberInteroObbligatorio

Versione

Esempio: 1

Campi aggiuntivi: No

ProductFileListData

ProductFileListData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API. Invia i file come multipart/form-data dopo aver creato upload_id, poi associali al prodotto. Il download richiede un token Bearer e il permesso per category; la risposta contiene i byte, senza indirizzo pubblico né password. Per mode=period scegli days (1–3650) oppure il precedente months, mai entrambi. Le condizioni vengono memorizzate all’acquisto; il rimborso revoca l’accesso solo alla riga rimborsata.
filesArray <ProductFileData > Obbligatorio

File del prodotto

Esempio: [{"category":"digital","created_at":"2026-01-01T12:00:00Z","current_version_id":"00000000-0000-4000-8000-000000000001","file_id":"00000000-0000-4000-8000-000000000001","filename":"manual.pdf","id":"00000000-0000-4000-8000-000000000001","label":"Manual","mime_type":"application/pdf","sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"state":"active","version_number":1}]
product_versionInteroObbligatorio

Versione corrente del prodotto per il controllo della concorrenza.

Esempio: 2

Campi aggiuntivi: No

Codici identificativi del prodotto

ProductIdentifiers · Schema · Schemi dei dati: Prodotti
eanStringa nullFacoltativo

Identificativo EAN del prodotto.

Stringa:minLength: 1maxLength: 100
isbnStringa nullFacoltativo

Identificativo ISBN.

Stringa:minLength: 1maxLength: 100
mpnStringa nullFacoltativo

Codice articolo del produttore.

Stringa:minLength: 1maxLength: 100
upcStringa nullFacoltativo

Identificativo UPC del prodotto.

Stringa:minLength: 1maxLength: 100

Campi aggiuntivi: No

Informazioni sui media allegati

ProductMediaData · Schema · Schemi dei dati: Prodotti
alt_textStringa nullObbligatorio

Testo alternativo dell’immagine.

Esempio: "example"
idStringaObbligatorio

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

Esempio: "example"
is_primaryBooleanoObbligatorio

Indica se è l’elemento principale.

Esempio: true
kindStringaObbligatorio

Forma della struttura dati, definita dai valori consentiti.

Vincoli
enum
["image", "video", "model_3d"]
Esempio: "image"
mime_typeStringaObbligatorio

Tipo di contenuto del media.

Esempio: "image/jpeg"
positionInteroObbligatorio

Posizione nella collezione ordinata.

Esempio: 1
urlStringa nullObbligatorio

URL della risorsa.

Esempio: "https://example.invalid/product.jpg"

Campi aggiuntivi: No

Configurazione dei prezzi e relative versioni di concorrenza

ProductPrice · Schema · Schemi dei dati: Prodotti
amountStringa nullObbligatorio

Importo decimale codificato come stringa JSON; null solo dove consentito.

Stringa:maxLength: 19
Vincoli · Stringa 1
pattern
"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
Esempio: "0.00"
currencyStringaObbligatorio

Codice della valuta dell’importo.

Vincoli
pattern
"^[A-Z]{3}$"
Esempio: "PLN"
expected_price_list_versionInteroObbligatorio

Versione del listino letta in precedenza e richiesta per questa scrittura.

minimum: 1maximum: 9223372036854775807
Esempio: 1
expected_versionInteroObbligatorio

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

minimum: 0maximum: 9223372036854775807
Esempio: 0
kindStringaObbligatorio

Forma della struttura dati, definita dai valori consentiti.

Vincoli
enum
["base", "market_fixed"]
Esempio: "base"
price_list_idStringaObbligatorio

Identificativo del listino.

minLength: 1maxLength: 63
Esempio: "example"
tax_includedBooleanoObbligatorio

Indica se il prezzo inviato include le imposte.

Esempio: true

Campi aggiuntivi: No

Elenca — Prodotti — Risposta

ProductSummaryData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
availabilityAvailabilityData Obbligatorio

Informazioni sulla disponibilità nel contesto selezionato.

Esempio: {"available_from":null,"available_until":null,"is_available":true}
brand_idStringa nullObbligatorio

Identificativo del marchio.

Esempio: null
conditionStringaObbligatorio

Condizione del prodotto.

Vincoli
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Esempio: "new"
created_atStringaObbligatorio

Data e ora di creazione.

format: "date-time"
Esempio: "2026-01-01T12:00:00Z"
idStringaObbligatorio

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

Esempio: "example"
nameStringa nullObbligatorio

Nome della risorsa nel contesto pertinente.

Esempio: "Example"
numberStringaObbligatorio

Numero dell’ordine o della richiesta destinato alle persone.

Esempio: "example"
pricePriceData nullObbligatorio

Informazioni sul prezzo nel contesto selezionato.

Esempio: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
price_versionInteroObbligatorio

Versione corrente del prezzo per il controllo della concorrenza.

Esempio: 1
primary_category_idStringa nullObbligatorio

Identificativo della categoria principale.

Esempio: "example"
primary_media_idStringa nullObbligatorio

Identificativo del media principale.

Esempio: "example"
publishedBooleanoObbligatorio

Indica se la risorsa è pubblicata.

Esempio: false
skuStringaObbligatorio

Codice di identificazione dell’articolo a magazzino.

Esempio: "example"
slugStringa nullObbligatorio

Segmento del percorso URL nella lingua selezionata.

Esempio: "example"
tax_category_idStringaObbligatorio

Identificativo della categoria fiscale.

Esempio: "example"
updated_atStringaObbligatorio

Data e ora dell’aggiornamento più recente.

format: "date-time"
Esempio: "2026-01-01T12:00:00Z"
variants_enabledBooleanoObbligatorio

Indica se il prodotto utilizza varianti.

Esempio: false
versionInteroObbligatorio

Versione della risorsa per il controllo della concorrenza.

Esempio: 1

Campi aggiuntivi: No

Aggiorna — Prodotti — Corpo della richiesta

ProductUpdate · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
brand_idStringa nullFacoltativo

Identificativo del marchio.

Stringa:minLength: 1maxLength: 63
conditionStringaFacoltativo

Condizione del prodotto.

Vincoli
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
descriptionStringa nullFacoltativo

Descrizione nella lingua selezionata.

Stringa:maxLength: 100000
Esempio: null
expected_variant_price_versionsOggettoCampi aggiuntivi: Intero
minimum: 0maximum: 9223372036854775807
Facoltativo

Versioni dei prezzi lette in precedenza, indicizzate per identificativo della variante.

maxProperties: 250
Vincoli
propertyNames
{"maxLength": 63, "minLength": 1}
expected_versionInteroObbligatorio

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

minimum: 1maximum: 9223372036854775807
Esempio: 1
feature_value_idsArray <Stringa> Facoltativo

Identificativi dei valori selezionati per le caratteristiche.

maxItems: 1000
Array:minLength: 1maxLength: 63
identifiersProductIdentifiers nullFacoltativo

Codici identificativi del prodotto.

market_idsArray <Stringa> Facoltativo

Identificativi dei mercati selezionati.

maxItems: 1000
Array:minLength: 1maxLength: 63
media_idsArray <Stringa> Facoltativo

Identificativi di media già esistenti.

maxItems: 30
Array:minLength: 1maxLength: 63
meta_descriptionStringa nullFacoltativo

Descrizione per i motori di ricerca nella lingua selezionata.

Stringa:maxLength: 160
meta_keywordsArray <Stringa> nullFacoltativo

Parole chiave per i motori di ricerca nella lingua selezionata.

Array:maxItems: 20
Array / Array:maxLength: 50
meta_titleStringa nullFacoltativo

Titolo per i motori di ricerca nella lingua selezionata.

Stringa:maxLength: 70
nameStringa nullFacoltativo

Nome della risorsa nel contesto pertinente.

Stringa:maxLength: 300
pricingProductPrice Facoltativo

Configurazione dei prezzi e relative versioni di concorrenza.

Esempio: {"amount":"0.00","currency":"PLN","expected_price_list_version":1,"expected_version":0,"kind":"base","price_list_id":"example","tax_included":true}
primary_category_idStringa nullFacoltativo

Identificativo della categoria principale.

Stringa:minLength: 1maxLength: 63
publishedBooleanoFacoltativo

Indica se la risorsa è pubblicata.

skuStringaFacoltativo

Codice di identificazione dell’articolo a magazzino.

minLength: 1maxLength: 100
Vincoli
pattern
"^\\S+$"
Esempio: "example"
slugStringa nullFacoltativo

Segmento del percorso URL nella lingua selezionata.

Stringa:maxLength: 160
tax_category_idStringa nullFacoltativo

Identificativo della categoria fiscale.

Stringa:minLength: 1maxLength: 63
variant_value_idsArray <Stringa> Facoltativo

Identificativi dei valori selezionati per la variante.

maxItems: 250
Array:minLength: 1maxLength: 63
variants_enabledBooleanoFacoltativo

Indica se il prodotto utilizza varianti.

Campi aggiuntivi: No

ProductVersion

ProductVersion · Questa operazione è stata ritirata e restituisce 409 senza modificare i dati. Imposta l’accesso per ogni file digitale scegliendo i destinatari.
expected_versionInteroObbligatorio

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

minimum: 1maximum: 9223372036854775807
Esempio: 1

Campi aggiuntivi: No

ReleaseData

ReleaseData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API. Invia i file come multipart/form-data dopo aver creato upload_id, poi associali al prodotto. Il download richiede un token Bearer e il permesso per category; la risposta contiene i byte, senza indirizzo pubblico né password. Per mode=period scegli days (1–3650) oppure il precedente months, mai entrambi. Le condizioni vengono memorizzate all’acquisto; il rimborso revoca l’accesso solo alla riga rimborsata.
changelogStringaObbligatorio

Descrizione delle modifiche

Esempio: "Manual update"
filesArray <ReleaseFileData > Obbligatorio

File del prodotto

Esempio: [{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}]
idStringaObbligatorio

Identificativo della risorsa; conservalo come restituito.

format: "uuid"
Esempio: "00000000-0000-4000-8000-000000000001"
manifest_sha256Stringa nullObbligatorio

Versioni digitali · SHA-256

Esempio: "1111111111111111111111111111111111111111111111111111111111111111"
published_atStringa nullObbligatorio

Pubblica versione · UTC

Stringa:format: "date-time"
Esempio: null
release_sequenceIntero nullObbligatorio

Versioni digitali · Posizione nella collezione ordinata.

Esempio: null
stateStringaObbligatorio

Stato

Esempio: "active"
version_labelStringaObbligatorio

Versione

Esempio: "1.0"
withdrawn_atStringa nullObbligatorio

Ritira offerta · UTC

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

Campi aggiuntivi: No

ReleaseDraft

ReleaseDraft · Questa operazione è stata ritirata e restituisce 409 senza modificare i dati. Imposta l’accesso per ogni file digitale scegliendo i destinatari.
changelogStringaFacoltativo

Descrizione delle modifiche

maxLength: 20000
Valore predefinito: ""
expected_versionInteroObbligatorio

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

minimum: 1maximum: 9223372036854775807
Esempio: 1
version_idsArray <Stringa> Obbligatorio

Versione · UUID[]

minItems: 1maxItems: 20
Array:format: "uuid"
Esempio: ["00000000-0000-4000-8000-000000000001"]
version_labelStringaObbligatorio

Versione

minLength: 1maxLength: 64
Esempio: "1.0"

Campi aggiuntivi: No

ReleaseFileData

ReleaseFileData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API. Invia i file come multipart/form-data dopo aver creato upload_id, poi associali al prodotto. Il download richiede un token Bearer e il permesso per category; la risposta contiene i byte, senza indirizzo pubblico né password. Per mode=period scegli days (1–3650) oppure il precedente months, mai entrambi. Le condizioni vengono memorizzate all’acquisto; il rimborso revoca l’accesso solo alla riga rimborsata.
file_idStringaObbligatorio

Identificativo della risorsa; conservalo come restituito. · file_id

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

Posizione nella collezione ordinata.

Esempio: 0
version_idStringaObbligatorio

Identificativo della risorsa; conservalo come restituito. · version_id

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

Campi aggiuntivi: No

ReleaseListData

ReleaseListData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API. Invia i file come multipart/form-data dopo aver creato upload_id, poi associali al prodotto. Il download richiede un token Bearer e il permesso per category; la risposta contiene i byte, senza indirizzo pubblico né password. Per mode=period scegli days (1–3650) oppure il precedente months, mai entrambi. Le condizioni vengono memorizzate all’acquisto; il rimborso revoca l’accesso solo alla riga rimborsata.
current_release_idStringa nullObbligatorio

Identificativo della risorsa; conservalo come restituito. · current_release_id

Stringa:format: "uuid"
Esempio: "00000000-0000-4000-8000-000000000001"
product_versionInteroObbligatorio

Versione corrente del prodotto per il controllo della concorrenza.

Esempio: 2
releasesArray <ReleaseData > Obbligatorio

Versioni digitali

Esempio: [{"changelog":"Manual update","files":[{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}],"id":"00000000-0000-4000-8000-000000000001","manifest_sha256":"1111111111111111111111111111111111111111111111111111111111111111","published_at":null,"release_sequence":null,"state":"active","version_label":"1.0","withdrawn_at":null}]
update_daysIntero nullObbligatorio

Numero di giorni (days; null)

Esempio: 365
update_modeStringaObbligatorio

Accesso ai file futuri dopo l’acquisto: none / period / unlimited

Esempio: "period"
update_monthsIntero nullObbligatorio

Mesi (months; null)

Esempio: null

Campi aggiuntivi: No

UpdatePolicy

UpdatePolicy · Questa operazione è stata ritirata e restituisce 409 senza modificare i dati. Imposta l’accesso per ogni file digitale scegliendo i destinatari.
daysIntero nullFacoltativo

Numero di giorni (1–3650; mode=period; months=null)

Intero:minimum: 1maximum: 3650
Esempio: 365
expected_versionInteroObbligatorio

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

minimum: 1maximum: 9223372036854775807
Esempio: 1
modeStringaObbligatorio

Accesso ai file futuri dopo l’acquisto: none / period / unlimited

Vincoli
enum
["none", "period", "unlimited"]
Esempio: "period"
monthsIntero nullFacoltativo

Mesi (1–120; mode=period; days=null)

Intero:minimum: 1maximum: 120
Esempio: null

Campi aggiuntivi: No

UploadCreate

UploadCreate · Campi, tipi e vincoli dei dati accettati o restituiti dall’API. Invia i file come multipart/form-data dopo aver creato upload_id, poi associali al prodotto. Il download richiede un token Bearer e il permesso per category; la risposta contiene i byte, senza indirizzo pubblico né password. Per mode=period scegli days (1–3650) oppure il precedente months, mai entrambi. Le condizioni vengono memorizzate all’acquisto; il rimborso revoca l’accesso solo alla riga rimborsata.
filenameStringaObbligatorio

File

minLength: 1maxLength: 255
Esempio: "manual.pdf"
product_idStringa nullFacoltativo

Identificativo del prodotto.

Vincoli · Stringa 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Esempio: "example"
sha256StringaObbligatorio

SHA-256 (hex, 64)

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

Dimensione in byte

minimum: 1maximum: 262144000
Esempio: 46

Campi aggiuntivi: No

UploadData

UploadData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API. Invia i file come multipart/form-data dopo aver creato upload_id, poi associali al prodotto. Il download richiede un token Bearer e il permesso per category; la risposta contiene i byte, senza indirizzo pubblico né password. Per mode=period scegli days (1–3650) oppure il precedente months, mai entrambi. Le condizioni vengono memorizzate all’acquisto; il rimborso revoca l’accesso solo alla riga rimborsata.
categoryFileCategory Obbligatorio

Categoria del file: internal / customer_document / digital

Esempio: "digital"
expires_atStringaObbligatorio

Data e ora di scadenza della credenziale.

format: "date-time"
Esempio: "2026-01-01T12:00:00Z"
filenameStringaObbligatorio

File

Esempio: "manual.pdf"
idStringaObbligatorio

Identificativo della risorsa; conservalo come restituito.

format: "uuid"
Esempio: "00000000-0000-4000-8000-000000000001"
product_idStringa nullObbligatorio

Identificativo del prodotto.

Esempio: "example"
received_bytesInteroObbligatorio

Caricamento… · Dimensione in byte

Esempio: 46
sha256StringaObbligatorio

SHA-256 (hex, 64)

Esempio: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesInteroObbligatorio

Dimensione in byte

Esempio: 46
statusStringaObbligatorio

Stato accettato da questa specifica operazione.

Esempio: "ready"

Campi aggiuntivi: No