Zum Inhalt springen
ShopentlyLearn

Datenschemas: Produkte

Datenschemas: Produkte. Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

Datenschemas

ApiResponse_ProductFileListData_

ApiResponse_ProductFileListData_ · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten. Dateien werden nach dem Erstellen von upload_id als multipart/form-data übertragen und anschließend einem Produkt zugeordnet. Downloads erfordern einen Bearer-Token und die Berechtigung für category; die Antwort enthält Dateibytes, keine öffentliche Adresse und kein Passwort. Für mode=period gilt days (1–3650) oder das bisherige months, niemals beides. Die Bedingungen werden beim Kauf gespeichert; eine Erstattung entzieht nur der erstatteten Position den Zugriff.
dataProductFileListData Erforderlich

Nutzdaten einer erfolgreichen Antwort.

Beispiel: {"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 Erforderlich

Metadaten der Antwort.

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

Zusätzliche Felder: Nein

ApiResponse_ReleaseListData_

ApiResponse_ReleaseListData_ · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten. Dateien werden nach dem Erstellen von upload_id als multipart/form-data übertragen und anschließend einem Produkt zugeordnet. Downloads erfordern einen Bearer-Token und die Berechtigung für category; die Antwort enthält Dateibytes, keine öffentliche Adresse und kein Passwort. Für mode=period gilt days (1–3650) oder das bisherige months, niemals beides. Die Bedingungen werden beim Kauf gespeichert; eine Erstattung entzieht nur der erstatteten Position den Zugriff.
dataReleaseListData Erforderlich

Nutzdaten einer erfolgreichen Antwort.

Beispiel: {"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 Erforderlich

Metadaten der Antwort.

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

Zusätzliche Felder: Nein

ApiResponse_UploadData_

ApiResponse_UploadData_ · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten. Dateien werden nach dem Erstellen von upload_id als multipart/form-data übertragen und anschließend einem Produkt zugeordnet. Downloads erfordern einen Bearer-Token und die Berechtigung für category; die Antwort enthält Dateibytes, keine öffentliche Adresse und kein Passwort. Für mode=period gilt days (1–3650) oder das bisherige months, niemals beides. Die Bedingungen werden beim Kauf gespeichert; eine Erstattung entzieht nur der erstatteten Position den Zugriff.
dataUploadData Erforderlich

Nutzdaten einer erfolgreichen Antwort.

Beispiel: {"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 Erforderlich

Metadaten der Antwort.

Beispiel: {"request_id":"example"}

Zusätzliche Felder: Nein

ApiResponse[AudienceData]

ApiResponse_AudienceData_ · Lies die Zugriffsregel und Produktversion. Die erste Veröffentlichung bleibt der zeitliche Bezugspunkt.
dataAudienceData Erforderlich

Nutzdaten einer erfolgreichen Antwort.

Beispiel: {"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 Erforderlich

Metadaten der Antwort.

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

Zusätzliche Felder: Nein

Auflisten — Produkte — Antwort

ApiResponse_list_ProductSummaryData__ · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.
dataArray <ProductSummaryData > Erforderlich

Beispielantwort · ApiResponse_list_ProductSummaryData__.

Beispiel: [{"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 Erforderlich

Metadaten der Antwort.

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

Zusätzliche Felder: Nein

Abrufen — Produkte — Antwort

ApiResponse_ProductDetailData_ · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.
dataProductDetailData Erforderlich

Beispielantwort · ProductDetailData.

Beispiel: {"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 Erforderlich

Metadaten der Antwort.

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

Zusätzliche Felder: Nein

AudienceChange

AudienceChange · Wähle neue, frühere oder bestimmte berechtigte Käufe. Ausgewählte Bestellungen müssen dieses Produkt bezahlt und nicht zurückgegeben haben.
audienceAudienceSelection Erforderlich

Ausdrückliche Zugriffsregel für die gemeinsam verkaufte Datei.

Beispiel: {"mode":"all_purchasers"}
expected_versionGanzzahlErforderlich

Vor dem Schreiben gelesene Version; eine Abweichung verhindert die Änderung.

minimum: 1maximum: 9223372036854775807
Beispiel: 1

Zusätzliche Felder: Nein

AudienceData

AudienceData · Lies die Zugriffsregel und Produktversion. Die erste Veröffentlichung bleibt der zeitliche Bezugspunkt.
anchor_atZeichenfolgeErforderlich

Erstveröffentlichung; bleibt bei Regeländerungen unverändert.

format: "date-time"
Beispiel: "2026-11-03T12:00:00Z"
effective_atZeichenfolgeErforderlich

Veröffentlichungszeit dieser Zugriffsregel.

format: "date-time"
Beispiel: "2026-11-03T12:00:00Z"
file_idZeichenfolgeErforderlich

Ressourcenkennung; unverändert aus der Antwort übernehmen. · file_id

Beispiel: "00000000-0000-4000-8000-000000000007"
file_version_idZeichenfolgeErforderlich

ID einer unveränderlichen Dateiversion.

Beispiel: "00000000-0000-4000-8000-000000000010"
historical_access_preservedBoolescher WertOptional

Frühere Zugriffsrechte bleiben bei engeren Regeln erhalten.

Standardwert: trueBeispiel: true
idZeichenfolgeErforderlich

Ressourcenkennung; unverändert aus der Antwort übernehmen.

Beispiel: "00000000-0000-4000-8000-000000000009"
lookback_daysGanzzahl nullErforderlich

1–3650 Tage vor Erstveröffentlichung; nur recent_and_new.

Beispiel: null
modeZeichenfolgeErforderlich

Ausdrückliche Zugriffsregel für die gemeinsam verkaufte Datei. new_purchases / recent_and_new / selected / all_purchasers.

Beispiel: "all_purchasers"
next_cursorZeichenfolge nullErforderlich

Fortsetzungswert für die nächste Seite oder null.

Beispiel: null
order_idsArray <Zeichenfolge> Erforderlich

Bezahlte, nicht erstattete Bestellungen mit diesem Produkt.

Beispiel: []
product_versionGanzzahlErforderlich

Aktuelle Produktversion zur Nebenläufigkeitskontrolle.

Beispiel: 3
revisionGanzzahlErforderlich

Fortlaufende Revision der Zugriffsregel.

Beispiel: 1

Zusätzliche Felder: Nein

AudienceSelection

AudienceSelection · Wähle neue, frühere oder bestimmte berechtigte Käufe. Ausgewählte Bestellungen müssen dieses Produkt bezahlt und nicht zurückgegeben haben.
lookback_daysGanzzahl nullOptional

1–3650 Tage vor Erstveröffentlichung; nur recent_and_new.

Ganzzahl:minimum: 1maximum: 3650
modeZeichenfolgeErforderlich

Ausdrückliche Zugriffsregel für die gemeinsam verkaufte Datei. new_purchases / recent_and_new / selected / all_purchasers.

Einschränkungen
enum
["new_purchases", "recent_and_new", "selected", "all_purchasers"]
Beispiel: "new_purchases"
order_idsArray <Zeichenfolge> Optional

Bezahlte, nicht erstattete Bestellungen mit diesem Produkt.

maxItems: 1000
Einschränkungen · Array 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Standardwert: []

Zusätzliche Felder: Nein

Verfügbarkeitsinformationen im ausgewählten Kontext

AvailabilityData · Schema · Datenschemas: Produkte
available_fromZeichenfolge nullErforderlich

Beginn der Verfügbarkeit.

Zeichenfolge:format: "date-time"
Beispiel: null
available_untilZeichenfolge nullErforderlich

Ende der Verfügbarkeit.

Zeichenfolge:format: "date-time"
Beispiel: null
is_availableBoolescher WertErforderlich

Gibt an, ob der Artikel in diesem Kontext verfügbar ist.

Beispiel: true

Zusätzliche Felder: Nein

FileAssign

FileAssign · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten. Dateien werden nach dem Erstellen von upload_id als multipart/form-data übertragen und anschließend einem Produkt zugeordnet. Downloads erfordern einen Bearer-Token und die Berechtigung für category; die Antwort enthält Dateibytes, keine öffentliche Adresse und kein Passwort. Für mode=period gilt days (1–3650) oder das bisherige months, niemals beides. Die Bedingungen werden beim Kauf gespeichert; eine Erstattung entzieht nur der erstatteten Position den Zugriff.
audienceAudienceSelection nullOptional

Ausdrückliche Zugriffsregel für die gemeinsam verkaufte Datei.

Beispiel: {"mode":"new_purchases"}
expected_versionGanzzahlErforderlich

Vor dem Schreiben gelesene Version; eine Abweichung verhindert die Änderung.

minimum: 1maximum: 9223372036854775807
Beispiel: 1
labelZeichenfolgeOptional

Name der Ressource im jeweiligen Kontext.

maxLength: 300
Standardwert: ""
upload_idZeichenfolgeErforderlich

Ressourcenkennung; unverändert aus der Antwort übernehmen. · upload_id

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

Zusätzliche Felder: Nein

FileCategory

FileCategory · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten. Dateien werden nach dem Erstellen von upload_id als multipart/form-data übertragen und anschließend einem Produkt zugeordnet. Downloads erfordern einen Bearer-Token und die Berechtigung für category; die Antwort enthält Dateibytes, keine öffentliche Adresse und kein Passwort. Für mode=period gilt days (1–3650) oder das bisherige months, niemals beides. Die Bedingungen werden beim Kauf gespeichert; eine Erstattung entzieht nur der erstatteten Position den Zugriff.
Zeichenfolge
Einschränkungen
enum
["internal", "customer_document", "digital"]

Zusätzliche Felder: Ja

Preisinformationen im ausgewählten Kontext

PriceData · Schema · Datenschemas: Produkte
amountZeichenfolgeErforderlich

Dezimalbetrag als JSON-Zeichenfolge; null nur, wenn ausdrücklich zulässig.

Beispiel: "0.00"
currencyZeichenfolgeErforderlich

Währungscode des Betrags.

Einschränkungen
pattern
"^[A-Z]{3}$"
Beispiel: "PLN"
minor_unitsGanzzahlErforderlich

Anzahl der Nachkommastellen der Währung.

minimum: 0maximum: 4
Beispiel: 2
tax_includedBoolescher WertErforderlich

Gibt an, ob der übermittelte Preis Steuern enthält.

Beispiel: true

Zusätzliche Felder: Nein

Preislisteninformationen

PriceListData · Schema · Datenschemas: Produkte
currencyZeichenfolgeErforderlich

Währungscode des Betrags.

idZeichenfolgeErforderlich

Ressourcenkennung; unverändert aus der Antwort übernehmen. (PriceListData).

tax_includedBoolescher WertErforderlich

Gibt an, ob der übermittelte Preis Steuern enthält.

versionGanzzahlErforderlich

Ressourcenversion zur Nebenläufigkeitskontrolle.

Zusätzliche Felder: Nein

Erstellen — Produkte — Anfrageinhalt

ProductCreate · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.
brand_idZeichenfolge nullOptional

Markenkennung.

Zeichenfolge:minLength: 1maxLength: 63
conditionZeichenfolgeOptional

Zustand des Produkts.

Einschränkungen
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Standardwert: "new"
descriptionZeichenfolge nullOptional

Beschreibung in der ausgewählten Sprache.

Zeichenfolge:maxLength: 100000
feature_value_idsArray <Zeichenfolge> Optional

Kennungen der ausgewählten Merkmalswerte.

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

Identifikationscodes des Produkts.

market_idsArray <Zeichenfolge> Optional

Kennungen der ausgewählten Märkte.

maxItems: 1000
Array:minLength: 1maxLength: 63
media_idsArray <Zeichenfolge> Optional

Kennungen bereits vorhandener Mediendateien.

maxItems: 30
Array:minLength: 1maxLength: 63
meta_descriptionZeichenfolge nullOptional

Suchmaschinenbeschreibung in der ausgewählten Sprache.

Zeichenfolge:maxLength: 160
meta_keywordsArray <Zeichenfolge> nullOptional

Suchmaschinen-Schlüsselwörter in der ausgewählten Sprache.

Array:maxItems: 20
Array / Array:maxLength: 50
meta_titleZeichenfolge nullOptional

Suchmaschinentitel in der ausgewählten Sprache.

Zeichenfolge:maxLength: 70
nameZeichenfolgeErforderlich

Name der Ressource im jeweiligen Kontext.

minLength: 1maxLength: 300
Beispiel: "Example"
pricingProductPrice Optional

Preiskonfiguration und zugehörige Versionsprüfungen.

primary_category_idZeichenfolge nullOptional

Kennung der Hauptkategorie.

Zeichenfolge:minLength: 1maxLength: 63
publishedBoolescher WertOptional

Gibt an, ob die Ressource veröffentlicht ist.

Standardwert: false
skuZeichenfolgeErforderlich

Artikelcode der Lagerhaltungseinheit.

minLength: 1maxLength: 100
Einschränkungen
pattern
"^\\S+$"
Beispiel: "example"
slugZeichenfolge nullOptional

URL-Pfadsegment in der ausgewählten Sprache.

Zeichenfolge:maxLength: 160
tax_category_idZeichenfolge nullOptional

Kennung der Steuerkategorie.

Zeichenfolge:minLength: 1maxLength: 63
variant_value_idsArray <Zeichenfolge> Optional

Kennungen der ausgewählten Variantenwerte.

maxItems: 250
Array:minLength: 1maxLength: 63
variants_enabledBoolescher WertOptional

Gibt an, ob das Produkt Varianten verwendet.

Standardwert: false

Zusätzliche Felder: Nein

Abrufen — Produkte — Antwort

ProductDetailData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.
availabilityAvailabilityData Erforderlich

Verfügbarkeitsinformationen im ausgewählten Kontext.

Beispiel: {"available_from":null,"available_until":null,"is_available":true}
brand_idZeichenfolge nullErforderlich

Markenkennung.

Beispiel: null
conditionZeichenfolgeErforderlich

Zustand des Produkts.

Einschränkungen
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Beispiel: "new"
created_atZeichenfolgeErforderlich

Zeitpunkt der Erstellung.

format: "date-time"
Beispiel: "2026-01-01T12:00:00Z"
descriptionZeichenfolge nullErforderlich

Beschreibung in der ausgewählten Sprache.

Beispiel: "example"
featuresArray <FeatureSelectionData > Erforderlich

Produktmerkmale.

Beispiel: [{"feature_id":"example","feature_name":"example","value":"example","value_id":"example"}]
idZeichenfolgeErforderlich

Ressourcenkennung; unverändert aus der Antwort übernehmen. (ProductDetailData).

Beispiel: "example"
identifiersObjektZusätzliche Felder: ZeichenfolgeErforderlich

Identifikationscodes des Produkts.

Beispiel: {}
mediaArray <ProductMediaData > Erforderlich

Informationen zu zugeordneten Medien.

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

Suchmaschinenbeschreibung in der ausgewählten Sprache.

Beispiel: "example"
meta_keywordsArray <Zeichenfolge> nullErforderlich

Suchmaschinen-Schlüsselwörter in der ausgewählten Sprache.

Beispiel: ["example"]
meta_titleZeichenfolge nullErforderlich

Suchmaschinentitel in der ausgewählten Sprache.

Beispiel: "example"
nameZeichenfolge nullErforderlich

Name der Ressource im jeweiligen Kontext.

Beispiel: "Example"
numberZeichenfolgeErforderlich

Für Benutzer sichtbare Bestell- oder Vorgangsnummer.

Beispiel: "example"
pricePriceData nullErforderlich

Preisinformationen im ausgewählten Kontext.

Beispiel: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
price_versionGanzzahlErforderlich

Aktuelle Preisversion zur Nebenläufigkeitskontrolle.

Beispiel: 1
primary_category_idZeichenfolge nullErforderlich

Kennung der Hauptkategorie.

Beispiel: "example"
primary_media_idZeichenfolge nullErforderlich

Kennung der primären Mediendatei.

Beispiel: "example"
publishedBoolescher WertErforderlich

Gibt an, ob die Ressource veröffentlicht ist.

Beispiel: false
skuZeichenfolgeErforderlich

Artikelcode der Lagerhaltungseinheit.

Beispiel: "example"
slugZeichenfolge nullErforderlich

URL-Pfadsegment in der ausgewählten Sprache.

Beispiel: "example"
tax_category_idZeichenfolgeErforderlich

Kennung der Steuerkategorie.

Beispiel: "example"
updated_atZeichenfolgeErforderlich

Zeitpunkt der letzten Änderung.

format: "date-time"
Beispiel: "2026-01-01T12:00:00Z"
variants_enabledBoolescher WertErforderlich

Gibt an, ob das Produkt Varianten verwendet.

Beispiel: false
versionGanzzahlErforderlich

Ressourcenversion zur Nebenläufigkeitskontrolle.

Beispiel: 1

Zusätzliche Felder: Nein

ProductFileData

ProductFileData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten. Dateien werden nach dem Erstellen von upload_id als multipart/form-data übertragen und anschließend einem Produkt zugeordnet. Downloads erfordern einen Bearer-Token und die Berechtigung für category; die Antwort enthält Dateibytes, keine öffentliche Adresse und kein Passwort. Für mode=period gilt days (1–3650) oder das bisherige months, niemals beides. Die Bedingungen werden beim Kauf gespeichert; eine Erstattung entzieht nur der erstatteten Position den Zugriff.
categoryFileCategory Erforderlich

Dateikategorie: internal / customer_document / digital

Beispiel: "digital"
created_atZeichenfolgeErforderlich

Zeitpunkt der Erstellung.

format: "date-time"
Beispiel: "2026-01-01T12:00:00Z"
current_version_idZeichenfolgeErforderlich

Ressourcenkennung; unverändert aus der Antwort übernehmen. · current_version_id

format: "uuid"
Beispiel: "00000000-0000-4000-8000-000000000001"
file_idZeichenfolgeErforderlich

Ressourcenkennung; unverändert aus der Antwort übernehmen. · file_id

format: "uuid"
Beispiel: "00000000-0000-4000-8000-000000000001"
filenameZeichenfolgeErforderlich

Datei

Beispiel: "manual.pdf"
idZeichenfolgeErforderlich

Ressourcenkennung; unverändert aus der Antwort übernehmen.

format: "uuid"
Beispiel: "00000000-0000-4000-8000-000000000001"
labelZeichenfolgeErforderlich

Name der Ressource im jeweiligen Kontext.

Beispiel: "Manual"
mime_typeZeichenfolgeErforderlich

Inhaltstyp des Mediums.

Beispiel: "application/pdf"
sha256ZeichenfolgeErforderlich

SHA-256 (hex, 64)

Beispiel: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesGanzzahlErforderlich

Größe in Bytes

Beispiel: 46
stateZeichenfolgeErforderlich

Status

Beispiel: "active"
version_numberGanzzahlErforderlich

Version

Beispiel: 1

Zusätzliche Felder: Nein

ProductFileListData

ProductFileListData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten. Dateien werden nach dem Erstellen von upload_id als multipart/form-data übertragen und anschließend einem Produkt zugeordnet. Downloads erfordern einen Bearer-Token und die Berechtigung für category; die Antwort enthält Dateibytes, keine öffentliche Adresse und kein Passwort. Für mode=period gilt days (1–3650) oder das bisherige months, niemals beides. Die Bedingungen werden beim Kauf gespeichert; eine Erstattung entzieht nur der erstatteten Position den Zugriff.
filesArray <ProductFileData > Erforderlich

Produktdateien

Beispiel: [{"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_versionGanzzahlErforderlich

Aktuelle Produktversion zur Nebenläufigkeitskontrolle.

Beispiel: 2

Zusätzliche Felder: Nein

Identifikationscodes des Produkts

ProductIdentifiers · Schema · Datenschemas: Produkte
eanZeichenfolge nullOptional

EAN-Produktkennung.

Zeichenfolge:minLength: 1maxLength: 100
isbnZeichenfolge nullOptional

ISBN-Kennung.

Zeichenfolge:minLength: 1maxLength: 100
mpnZeichenfolge nullOptional

Herstellerteilenummer.

Zeichenfolge:minLength: 1maxLength: 100
upcZeichenfolge nullOptional

UPC-Produktkennung.

Zeichenfolge:minLength: 1maxLength: 100

Zusätzliche Felder: Nein

Informationen zu zugeordneten Medien

ProductMediaData · Schema · Datenschemas: Produkte
alt_textZeichenfolge nullErforderlich

Alternativtext des Bildes.

Beispiel: "example"
idZeichenfolgeErforderlich

Ressourcenkennung; unverändert aus der Antwort übernehmen. (ProductMediaData).

Beispiel: "example"
is_primaryBoolescher WertErforderlich

Gibt an, ob dies der Haupteintrag ist.

Beispiel: true
kindZeichenfolgeErforderlich

Durch die zulässigen Werte beschriebene Variante der Datenstruktur.

Einschränkungen
enum
["image", "video", "model_3d"]
Beispiel: "image"
mime_typeZeichenfolgeErforderlich

Inhaltstyp des Mediums.

Beispiel: "image/jpeg"
positionGanzzahlErforderlich

Position in der geordneten Sammlung.

Beispiel: 1
urlZeichenfolge nullErforderlich

URL der Ressource.

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

Zusätzliche Felder: Nein

Preiskonfiguration und zugehörige Versionsprüfungen

ProductPrice · Schema · Datenschemas: Produkte
amountZeichenfolge nullErforderlich

Dezimalbetrag als JSON-Zeichenfolge; null nur, wenn ausdrücklich zulässig.

Zeichenfolge:maxLength: 19
Einschränkungen · Zeichenfolge 1
pattern
"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
Beispiel: "0.00"
currencyZeichenfolgeErforderlich

Währungscode des Betrags.

Einschränkungen
pattern
"^[A-Z]{3}$"
Beispiel: "PLN"
expected_price_list_versionGanzzahlErforderlich

Zuvor gelesene Preislistenversion für diesen Schreibvorgang.

minimum: 1maximum: 9223372036854775807
Beispiel: 1
expected_versionGanzzahlErforderlich

Vor dem Schreiben gelesene Version; eine Abweichung verhindert die Änderung.

minimum: 0maximum: 9223372036854775807
Beispiel: 0
kindZeichenfolgeErforderlich

Durch die zulässigen Werte beschriebene Variante der Datenstruktur.

Einschränkungen
enum
["base", "market_fixed"]
Beispiel: "base"
price_list_idZeichenfolgeErforderlich

Preislistenkennung.

minLength: 1maxLength: 63
Beispiel: "example"
tax_includedBoolescher WertErforderlich

Gibt an, ob der übermittelte Preis Steuern enthält.

Beispiel: true

Zusätzliche Felder: Nein

Auflisten — Produkte — Antwort

ProductSummaryData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.
availabilityAvailabilityData Erforderlich

Verfügbarkeitsinformationen im ausgewählten Kontext.

Beispiel: {"available_from":null,"available_until":null,"is_available":true}
brand_idZeichenfolge nullErforderlich

Markenkennung.

Beispiel: null
conditionZeichenfolgeErforderlich

Zustand des Produkts.

Einschränkungen
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Beispiel: "new"
created_atZeichenfolgeErforderlich

Zeitpunkt der Erstellung.

format: "date-time"
Beispiel: "2026-01-01T12:00:00Z"
idZeichenfolgeErforderlich

Ressourcenkennung; unverändert aus der Antwort übernehmen. (ProductSummaryData).

Beispiel: "example"
nameZeichenfolge nullErforderlich

Name der Ressource im jeweiligen Kontext.

Beispiel: "Example"
numberZeichenfolgeErforderlich

Für Benutzer sichtbare Bestell- oder Vorgangsnummer.

Beispiel: "example"
pricePriceData nullErforderlich

Preisinformationen im ausgewählten Kontext.

Beispiel: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
price_versionGanzzahlErforderlich

Aktuelle Preisversion zur Nebenläufigkeitskontrolle.

Beispiel: 1
primary_category_idZeichenfolge nullErforderlich

Kennung der Hauptkategorie.

Beispiel: "example"
primary_media_idZeichenfolge nullErforderlich

Kennung der primären Mediendatei.

Beispiel: "example"
publishedBoolescher WertErforderlich

Gibt an, ob die Ressource veröffentlicht ist.

Beispiel: false
skuZeichenfolgeErforderlich

Artikelcode der Lagerhaltungseinheit.

Beispiel: "example"
slugZeichenfolge nullErforderlich

URL-Pfadsegment in der ausgewählten Sprache.

Beispiel: "example"
tax_category_idZeichenfolgeErforderlich

Kennung der Steuerkategorie.

Beispiel: "example"
updated_atZeichenfolgeErforderlich

Zeitpunkt der letzten Änderung.

format: "date-time"
Beispiel: "2026-01-01T12:00:00Z"
variants_enabledBoolescher WertErforderlich

Gibt an, ob das Produkt Varianten verwendet.

Beispiel: false
versionGanzzahlErforderlich

Ressourcenversion zur Nebenläufigkeitskontrolle.

Beispiel: 1

Zusätzliche Felder: Nein

Aktualisieren — Produkte — Anfrageinhalt

ProductUpdate · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.
brand_idZeichenfolge nullOptional

Markenkennung.

Zeichenfolge:minLength: 1maxLength: 63
conditionZeichenfolgeOptional

Zustand des Produkts.

Einschränkungen
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
descriptionZeichenfolge nullOptional

Beschreibung in der ausgewählten Sprache.

Zeichenfolge:maxLength: 100000
Beispiel: null
expected_variant_price_versionsObjektZusätzliche Felder: Ganzzahl
minimum: 0maximum: 9223372036854775807
Optional

Zuvor gelesene Preisversionen, zugeordnet nach Variantenkennung.

maxProperties: 250
Einschränkungen
propertyNames
{"maxLength": 63, "minLength": 1}
expected_versionGanzzahlErforderlich

Vor dem Schreiben gelesene Version; eine Abweichung verhindert die Änderung.

minimum: 1maximum: 9223372036854775807
Beispiel: 1
feature_value_idsArray <Zeichenfolge> Optional

Kennungen der ausgewählten Merkmalswerte.

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

Identifikationscodes des Produkts.

market_idsArray <Zeichenfolge> Optional

Kennungen der ausgewählten Märkte.

maxItems: 1000
Array:minLength: 1maxLength: 63
media_idsArray <Zeichenfolge> Optional

Kennungen bereits vorhandener Mediendateien.

maxItems: 30
Array:minLength: 1maxLength: 63
meta_descriptionZeichenfolge nullOptional

Suchmaschinenbeschreibung in der ausgewählten Sprache.

Zeichenfolge:maxLength: 160
meta_keywordsArray <Zeichenfolge> nullOptional

Suchmaschinen-Schlüsselwörter in der ausgewählten Sprache.

Array:maxItems: 20
Array / Array:maxLength: 50
meta_titleZeichenfolge nullOptional

Suchmaschinentitel in der ausgewählten Sprache.

Zeichenfolge:maxLength: 70
nameZeichenfolge nullOptional

Name der Ressource im jeweiligen Kontext.

Zeichenfolge:maxLength: 300
pricingProductPrice Optional

Preiskonfiguration und zugehörige Versionsprüfungen.

Beispiel: {"amount":"0.00","currency":"PLN","expected_price_list_version":1,"expected_version":0,"kind":"base","price_list_id":"example","tax_included":true}
primary_category_idZeichenfolge nullOptional

Kennung der Hauptkategorie.

Zeichenfolge:minLength: 1maxLength: 63
publishedBoolescher WertOptional

Gibt an, ob die Ressource veröffentlicht ist.

skuZeichenfolgeOptional

Artikelcode der Lagerhaltungseinheit.

minLength: 1maxLength: 100
Einschränkungen
pattern
"^\\S+$"
Beispiel: "example"
slugZeichenfolge nullOptional

URL-Pfadsegment in der ausgewählten Sprache.

Zeichenfolge:maxLength: 160
tax_category_idZeichenfolge nullOptional

Kennung der Steuerkategorie.

Zeichenfolge:minLength: 1maxLength: 63
variant_value_idsArray <Zeichenfolge> Optional

Kennungen der ausgewählten Variantenwerte.

maxItems: 250
Array:minLength: 1maxLength: 63
variants_enabledBoolescher WertOptional

Gibt an, ob das Produkt Varianten verwendet.

Zusätzliche Felder: Nein

ProductVersion

ProductVersion · Diese Operation wurde eingestellt und gibt 409 zurück, ohne Daten zu ändern. Lege den Zugriff für jede digitale Datei über die Empfängerauswahl fest.
expected_versionGanzzahlErforderlich

Vor dem Schreiben gelesene Version; eine Abweichung verhindert die Änderung.

minimum: 1maximum: 9223372036854775807
Beispiel: 1

Zusätzliche Felder: Nein

ReleaseData

ReleaseData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten. Dateien werden nach dem Erstellen von upload_id als multipart/form-data übertragen und anschließend einem Produkt zugeordnet. Downloads erfordern einen Bearer-Token und die Berechtigung für category; die Antwort enthält Dateibytes, keine öffentliche Adresse und kein Passwort. Für mode=period gilt days (1–3650) oder das bisherige months, niemals beides. Die Bedingungen werden beim Kauf gespeichert; eine Erstattung entzieht nur der erstatteten Position den Zugriff.
changelogZeichenfolgeErforderlich

Änderungsbeschreibung

Beispiel: "Manual update"
filesArray <ReleaseFileData > Erforderlich

Produktdateien

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

Ressourcenkennung; unverändert aus der Antwort übernehmen.

format: "uuid"
Beispiel: "00000000-0000-4000-8000-000000000001"
manifest_sha256Zeichenfolge nullErforderlich

Digitale Ausgaben · SHA-256

Beispiel: "1111111111111111111111111111111111111111111111111111111111111111"
published_atZeichenfolge nullErforderlich

Ausgabe veröffentlichen · UTC

Zeichenfolge:format: "date-time"
Beispiel: null
release_sequenceGanzzahl nullErforderlich

Digitale Ausgaben · Position in der geordneten Sammlung.

Beispiel: null
stateZeichenfolgeErforderlich

Status

Beispiel: "active"
version_labelZeichenfolgeErforderlich

Version

Beispiel: "1.0"
withdrawn_atZeichenfolge nullErforderlich

Angebot zurückziehen · UTC

Zeichenfolge:format: "date-time"
Beispiel: null

Zusätzliche Felder: Nein

ReleaseDraft

ReleaseDraft · Diese Operation wurde eingestellt und gibt 409 zurück, ohne Daten zu ändern. Lege den Zugriff für jede digitale Datei über die Empfängerauswahl fest.
changelogZeichenfolgeOptional

Änderungsbeschreibung

maxLength: 20000
Standardwert: ""
expected_versionGanzzahlErforderlich

Vor dem Schreiben gelesene Version; eine Abweichung verhindert die Änderung.

minimum: 1maximum: 9223372036854775807
Beispiel: 1
version_idsArray <Zeichenfolge> Erforderlich

Version · UUID[]

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

Version

minLength: 1maxLength: 64
Beispiel: "1.0"

Zusätzliche Felder: Nein

ReleaseFileData

ReleaseFileData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten. Dateien werden nach dem Erstellen von upload_id als multipart/form-data übertragen und anschließend einem Produkt zugeordnet. Downloads erfordern einen Bearer-Token und die Berechtigung für category; die Antwort enthält Dateibytes, keine öffentliche Adresse und kein Passwort. Für mode=period gilt days (1–3650) oder das bisherige months, niemals beides. Die Bedingungen werden beim Kauf gespeichert; eine Erstattung entzieht nur der erstatteten Position den Zugriff.
file_idZeichenfolgeErforderlich

Ressourcenkennung; unverändert aus der Antwort übernehmen. · file_id

format: "uuid"
Beispiel: "00000000-0000-4000-8000-000000000001"
sort_orderGanzzahlErforderlich

Position in der geordneten Sammlung.

Beispiel: 0
version_idZeichenfolgeErforderlich

Ressourcenkennung; unverändert aus der Antwort übernehmen. · version_id

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

Zusätzliche Felder: Nein

ReleaseListData

ReleaseListData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten. Dateien werden nach dem Erstellen von upload_id als multipart/form-data übertragen und anschließend einem Produkt zugeordnet. Downloads erfordern einen Bearer-Token und die Berechtigung für category; die Antwort enthält Dateibytes, keine öffentliche Adresse und kein Passwort. Für mode=period gilt days (1–3650) oder das bisherige months, niemals beides. Die Bedingungen werden beim Kauf gespeichert; eine Erstattung entzieht nur der erstatteten Position den Zugriff.
current_release_idZeichenfolge nullErforderlich

Ressourcenkennung; unverändert aus der Antwort übernehmen. · current_release_id

Zeichenfolge:format: "uuid"
Beispiel: "00000000-0000-4000-8000-000000000001"
product_versionGanzzahlErforderlich

Aktuelle Produktversion zur Nebenläufigkeitskontrolle.

Beispiel: 2
releasesArray <ReleaseData > Erforderlich

Digitale Ausgaben

Beispiel: [{"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_daysGanzzahl nullErforderlich

Anzahl der Tage (days; null)

Beispiel: 365
update_modeZeichenfolgeErforderlich

Zugriff auf zukünftige Dateien nach dem Kauf: none / period / unlimited

Beispiel: "period"
update_monthsGanzzahl nullErforderlich

Monate (months; null)

Beispiel: null

Zusätzliche Felder: Nein

UpdatePolicy

UpdatePolicy · Diese Operation wurde eingestellt und gibt 409 zurück, ohne Daten zu ändern. Lege den Zugriff für jede digitale Datei über die Empfängerauswahl fest.
daysGanzzahl nullOptional

Anzahl der Tage (1–3650; mode=period; months=null)

Ganzzahl:minimum: 1maximum: 3650
Beispiel: 365
expected_versionGanzzahlErforderlich

Vor dem Schreiben gelesene Version; eine Abweichung verhindert die Änderung.

minimum: 1maximum: 9223372036854775807
Beispiel: 1
modeZeichenfolgeErforderlich

Zugriff auf zukünftige Dateien nach dem Kauf: none / period / unlimited

Einschränkungen
enum
["none", "period", "unlimited"]
Beispiel: "period"
monthsGanzzahl nullOptional

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

Ganzzahl:minimum: 1maximum: 120
Beispiel: null

Zusätzliche Felder: Nein

UploadCreate

UploadCreate · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten. Dateien werden nach dem Erstellen von upload_id als multipart/form-data übertragen und anschließend einem Produkt zugeordnet. Downloads erfordern einen Bearer-Token und die Berechtigung für category; die Antwort enthält Dateibytes, keine öffentliche Adresse und kein Passwort. Für mode=period gilt days (1–3650) oder das bisherige months, niemals beides. Die Bedingungen werden beim Kauf gespeichert; eine Erstattung entzieht nur der erstatteten Position den Zugriff.
filenameZeichenfolgeErforderlich

Datei

minLength: 1maxLength: 255
Beispiel: "manual.pdf"
product_idZeichenfolge nullOptional

Produktkennung.

Einschränkungen · Zeichenfolge 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Beispiel: "example"
sha256ZeichenfolgeErforderlich

SHA-256 (hex, 64)

Einschränkungen
pattern
"^[0-9a-f]{64}$"
Beispiel: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesGanzzahlErforderlich

Größe in Bytes

minimum: 1maximum: 262144000
Beispiel: 46

Zusätzliche Felder: Nein

UploadData

UploadData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten. Dateien werden nach dem Erstellen von upload_id als multipart/form-data übertragen und anschließend einem Produkt zugeordnet. Downloads erfordern einen Bearer-Token und die Berechtigung für category; die Antwort enthält Dateibytes, keine öffentliche Adresse und kein Passwort. Für mode=period gilt days (1–3650) oder das bisherige months, niemals beides. Die Bedingungen werden beim Kauf gespeichert; eine Erstattung entzieht nur der erstatteten Position den Zugriff.
categoryFileCategory Erforderlich

Dateikategorie: internal / customer_document / digital

Beispiel: "digital"
expires_atZeichenfolgeErforderlich

Ablaufdatum und Ablaufzeit des Tokens.

format: "date-time"
Beispiel: "2026-01-01T12:00:00Z"
filenameZeichenfolgeErforderlich

Datei

Beispiel: "manual.pdf"
idZeichenfolgeErforderlich

Ressourcenkennung; unverändert aus der Antwort übernehmen.

format: "uuid"
Beispiel: "00000000-0000-4000-8000-000000000001"
product_idZeichenfolge nullErforderlich

Produktkennung.

Beispiel: "example"
received_bytesGanzzahlErforderlich

Wird hochgeladen… · Größe in Bytes

Beispiel: 46
sha256ZeichenfolgeErforderlich

SHA-256 (hex, 64)

Beispiel: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesGanzzahlErforderlich

Größe in Bytes

Beispiel: 46
statusZeichenfolgeErforderlich

Von dieser konkreten Operation akzeptierter Status.

Beispiel: "ready"

Zusätzliche Felder: Nein