Datenschemas: Produkte

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

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

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

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

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

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: 20

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

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

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

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

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

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

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: 20

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

Beispiel: null

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