Ga naar de inhoud
ShopentlyLearn

Gegevensschema’s: Producten

Gegevensschema’s: Producten. Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

Gegevensschema’s

Lijst ophalen — Producten — Antwoord

ApiResponse_list_ProductSummaryData__ · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.
dataArray <ProductSummaryData > Verplicht

Voorbeeldantwoord · ApiResponse_list_ProductSummaryData__.

Voorbeeld: [{"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 Verplicht

Metadata van het antwoord.

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

Aanvullende velden: Nee

Ophalen — Producten — Antwoord

ApiResponse_ProductDetailData_ · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.
dataProductDetailData Verplicht

Voorbeeldantwoord · ProductDetailData.

Voorbeeld: {"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 Verplicht

Metadata van het antwoord.

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

Aanvullende velden: Nee

Beschikbaarheid in de geselecteerde context

AvailabilityData · Schema · Gegevensschema’s: Producten
available_fromTekenreeks nullVerplicht

Begin van de beschikbaarheid.

Tekenreeks:format: "date-time"
Voorbeeld: null
available_untilTekenreeks nullVerplicht

Einde van de beschikbaarheid.

Tekenreeks:format: "date-time"
Voorbeeld: null
is_availableBooleaanse waardeVerplicht

Of het item beschikbaar is in deze context.

Voorbeeld: true

Aanvullende velden: Nee

Prijsgegevens in de geselecteerde context

PriceData · Schema · Gegevensschema’s: Producten
amountTekenreeksVerplicht

Decimaal bedrag als JSON-tekenreeks; null uitsluitend waar toegestaan.

Voorbeeld: "0.00"
currencyTekenreeksVerplicht

Valutacode voor het bedrag.

Beperkingen
pattern
"^[A-Z]{3}$"
Voorbeeld: "PLN"
minor_unitsGeheel getalVerplicht

Aantal decimalen van de valuta.

minimum: 0maximum: 4
Voorbeeld: 2
tax_includedBooleaanse waardeVerplicht

Of de opgegeven prijs inclusief belasting is.

Voorbeeld: true

Aanvullende velden: Nee

Prijslijstgegevens

PriceListData · Schema · Gegevensschema’s: Producten
currencyTekenreeksVerplicht

Valutacode voor het bedrag.

idTekenreeksVerplicht

Resource-identificatie; bewaar deze zoals teruggegeven. (PriceListData).

tax_includedBooleaanse waardeVerplicht

Of de opgegeven prijs inclusief belasting is.

versionGeheel getalVerplicht

Resourceversie voor controle op gelijktijdige wijzigingen.

Aanvullende velden: Nee

Aanmaken — Producten — Verzoekinhoud

ProductCreate · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.
brand_idTekenreeks nullOptioneel

Merkidentificatie.

Tekenreeks:minLength: 1maxLength: 63
conditionTekenreeksOptioneel

Conditie van het product.

Beperkingen
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Standaard: "new"
descriptionTekenreeks nullOptioneel

Beschrijving in de geselecteerde taal.

Tekenreeks:maxLength: 100000
feature_value_idsArray <Tekenreeks> Optioneel

Identificaties van geselecteerde kenmerkwaarden.

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

Productidentificatiecodes.

market_idsArray <Tekenreeks> Optioneel

Identificaties van geselecteerde markten.

maxItems: 1000
Array:minLength: 1maxLength: 63
media_idsArray <Tekenreeks> Optioneel

Identificaties van bestaande mediabestanden.

maxItems: 20
Array:minLength: 1maxLength: 63
meta_descriptionTekenreeks nullOptioneel

Zoekmachinebeschrijving in de geselecteerde taal.

Tekenreeks:maxLength: 160
meta_keywordsArray <Tekenreeks> nullOptioneel

Zoekmachinetrefwoorden in de geselecteerde taal.

Array:maxItems: 20
Array / Array:maxLength: 50
meta_titleTekenreeks nullOptioneel

Zoekmachinetitel in de geselecteerde taal.

Tekenreeks:maxLength: 70
nameTekenreeksVerplicht

Resourcenaam in de betreffende context.

minLength: 1maxLength: 300
Voorbeeld: "Example"
pricingProductPrice Optioneel

Prijsconfiguratie en versies voor gelijktijdige wijzigingen.

primary_category_idTekenreeks nullOptioneel

Identificatie van de primaire categorie.

Tekenreeks:minLength: 1maxLength: 63
publishedBooleaanse waardeOptioneel

Of de resource is gepubliceerd.

Standaard: false
skuTekenreeksVerplicht

Voorraadartikelcode (SKU).

minLength: 1maxLength: 100
Beperkingen
pattern
"^\\S+$"
Voorbeeld: "example"
slugTekenreeks nullOptioneel

URL-padsegment in de geselecteerde taal.

Tekenreeks:maxLength: 160
tax_category_idTekenreeks nullOptioneel

Identificatie van de belastingcategorie.

Tekenreeks:minLength: 1maxLength: 63
variant_value_idsArray <Tekenreeks> Optioneel

Identificaties van geselecteerde variantwaarden.

maxItems: 250
Array:minLength: 1maxLength: 63
variants_enabledBooleaanse waardeOptioneel

Of het product varianten gebruikt.

Standaard: false

Aanvullende velden: Nee

Ophalen — Producten — Antwoord

ProductDetailData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.
availabilityAvailabilityData Verplicht

Beschikbaarheid in de geselecteerde context.

Voorbeeld: {"available_from":null,"available_until":null,"is_available":true}
brand_idTekenreeks nullVerplicht

Merkidentificatie.

Voorbeeld: null
conditionTekenreeksVerplicht

Conditie van het product.

Beperkingen
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Voorbeeld: "new"
created_atTekenreeksVerplicht

Tijdstip van aanmaak.

format: "date-time"
Voorbeeld: "2026-01-01T12:00:00Z"
descriptionTekenreeks nullVerplicht

Beschrijving in de geselecteerde taal.

Voorbeeld: "example"
featuresArray <FeatureSelectionData > Verplicht

Productkenmerken.

Voorbeeld: [{"feature_id":"example","feature_name":"example","value":"example","value_id":"example"}]
idTekenreeksVerplicht

Resource-identificatie; bewaar deze zoals teruggegeven. (ProductDetailData).

Voorbeeld: "example"
identifiersObjectAanvullende velden: TekenreeksVerplicht

Productidentificatiecodes.

Voorbeeld: {}
mediaArray <ProductMediaData > Verplicht

Informatie over gekoppelde media.

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

Zoekmachinebeschrijving in de geselecteerde taal.

Voorbeeld: "example"
meta_keywordsArray <Tekenreeks> nullVerplicht

Zoekmachinetrefwoorden in de geselecteerde taal.

Voorbeeld: ["example"]
meta_titleTekenreeks nullVerplicht

Zoekmachinetitel in de geselecteerde taal.

Voorbeeld: "example"
nameTekenreeks nullVerplicht

Resourcenaam in de betreffende context.

Voorbeeld: "Example"
numberTekenreeksVerplicht

Bestel- of aanvraagnummer voor menselijk gebruik.

Voorbeeld: "example"
pricePriceData nullVerplicht

Prijsgegevens in de geselecteerde context.

Voorbeeld: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
price_versionGeheel getalVerplicht

Huidige prijsversie voor controle op gelijktijdige wijzigingen.

Voorbeeld: 1
primary_category_idTekenreeks nullVerplicht

Identificatie van de primaire categorie.

Voorbeeld: "example"
primary_media_idTekenreeks nullVerplicht

Identificatie van het primaire mediabestand.

Voorbeeld: "example"
publishedBooleaanse waardeVerplicht

Of de resource is gepubliceerd.

Voorbeeld: false
skuTekenreeksVerplicht

Voorraadartikelcode (SKU).

Voorbeeld: "example"
slugTekenreeks nullVerplicht

URL-padsegment in de geselecteerde taal.

Voorbeeld: "example"
tax_category_idTekenreeksVerplicht

Identificatie van de belastingcategorie.

Voorbeeld: "example"
updated_atTekenreeksVerplicht

Tijdstip van de meest recente wijziging.

format: "date-time"
Voorbeeld: "2026-01-01T12:00:00Z"
variants_enabledBooleaanse waardeVerplicht

Of het product varianten gebruikt.

Voorbeeld: false
versionGeheel getalVerplicht

Resourceversie voor controle op gelijktijdige wijzigingen.

Voorbeeld: 1

Aanvullende velden: Nee

Productidentificatiecodes

ProductIdentifiers · Schema · Gegevensschema’s: Producten
eanTekenreeks nullOptioneel

EAN-productidentificatie.

Tekenreeks:minLength: 1maxLength: 100
isbnTekenreeks nullOptioneel

ISBN-identificatie.

Tekenreeks:minLength: 1maxLength: 100
mpnTekenreeks nullOptioneel

Onderdeelnummer van de fabrikant.

Tekenreeks:minLength: 1maxLength: 100
upcTekenreeks nullOptioneel

UPC-productidentificatie.

Tekenreeks:minLength: 1maxLength: 100

Aanvullende velden: Nee

Informatie over gekoppelde media

ProductMediaData · Schema · Gegevensschema’s: Producten
alt_textTekenreeks nullVerplicht

Alternatieve tekst voor een afbeelding.

Voorbeeld: "example"
idTekenreeksVerplicht

Resource-identificatie; bewaar deze zoals teruggegeven. (ProductMediaData).

Voorbeeld: "example"
is_primaryBooleaanse waardeVerplicht

Of dit het primaire item is.

Voorbeeld: true
kindTekenreeksVerplicht

Variant van de gegevensstructuur, zoals beschreven door de toegestane waarden.

Beperkingen
enum
["image", "video", "model_3d"]
Voorbeeld: "image"
mime_typeTekenreeksVerplicht

Inhoudstype van de media.

Voorbeeld: "image/jpeg"
positionGeheel getalVerplicht

Positie in de geordende verzameling.

Voorbeeld: 1
urlTekenreeks nullVerplicht

Resource-URL.

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

Aanvullende velden: Nee

Prijsconfiguratie en versies voor gelijktijdige wijzigingen

ProductPrice · Schema · Gegevensschema’s: Producten
amountTekenreeks nullVerplicht

Decimaal bedrag als JSON-tekenreeks; null uitsluitend waar toegestaan.

Tekenreeks:maxLength: 19
Beperkingen · Tekenreeks 1
pattern
"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
Voorbeeld: "0.00"
currencyTekenreeksVerplicht

Valutacode voor het bedrag.

Beperkingen
pattern
"^[A-Z]{3}$"
Voorbeeld: "PLN"
expected_price_list_versionGeheel getalVerplicht

Eerder gelezen prijslijstversie die voor deze schrijfbewerking vereist is.

minimum: 1maximum: 9223372036854775807
Voorbeeld: 1
expected_versionGeheel getalVerplicht

Versie die vóór de schrijfbewerking is gelezen; bij afwijking wordt de wijziging geweigerd.

minimum: 0maximum: 9223372036854775807
Voorbeeld: 0
kindTekenreeksVerplicht

Variant van de gegevensstructuur, zoals beschreven door de toegestane waarden.

Beperkingen
enum
["base", "market_fixed"]
Voorbeeld: "base"
price_list_idTekenreeksVerplicht

Prijslijstidentificatie.

minLength: 1maxLength: 63
Voorbeeld: "example"
tax_includedBooleaanse waardeVerplicht

Of de opgegeven prijs inclusief belasting is.

Voorbeeld: true

Aanvullende velden: Nee

Lijst ophalen — Producten — Antwoord

ProductSummaryData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.
availabilityAvailabilityData Verplicht

Beschikbaarheid in de geselecteerde context.

Voorbeeld: {"available_from":null,"available_until":null,"is_available":true}
brand_idTekenreeks nullVerplicht

Merkidentificatie.

Voorbeeld: null
conditionTekenreeksVerplicht

Conditie van het product.

Beperkingen
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Voorbeeld: "new"
created_atTekenreeksVerplicht

Tijdstip van aanmaak.

format: "date-time"
Voorbeeld: "2026-01-01T12:00:00Z"
idTekenreeksVerplicht

Resource-identificatie; bewaar deze zoals teruggegeven. (ProductSummaryData).

Voorbeeld: "example"
nameTekenreeks nullVerplicht

Resourcenaam in de betreffende context.

Voorbeeld: "Example"
numberTekenreeksVerplicht

Bestel- of aanvraagnummer voor menselijk gebruik.

Voorbeeld: "example"
pricePriceData nullVerplicht

Prijsgegevens in de geselecteerde context.

Voorbeeld: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
price_versionGeheel getalVerplicht

Huidige prijsversie voor controle op gelijktijdige wijzigingen.

Voorbeeld: 1
primary_category_idTekenreeks nullVerplicht

Identificatie van de primaire categorie.

Voorbeeld: "example"
primary_media_idTekenreeks nullVerplicht

Identificatie van het primaire mediabestand.

Voorbeeld: "example"
publishedBooleaanse waardeVerplicht

Of de resource is gepubliceerd.

Voorbeeld: false
skuTekenreeksVerplicht

Voorraadartikelcode (SKU).

Voorbeeld: "example"
slugTekenreeks nullVerplicht

URL-padsegment in de geselecteerde taal.

Voorbeeld: "example"
tax_category_idTekenreeksVerplicht

Identificatie van de belastingcategorie.

Voorbeeld: "example"
updated_atTekenreeksVerplicht

Tijdstip van de meest recente wijziging.

format: "date-time"
Voorbeeld: "2026-01-01T12:00:00Z"
variants_enabledBooleaanse waardeVerplicht

Of het product varianten gebruikt.

Voorbeeld: false
versionGeheel getalVerplicht

Resourceversie voor controle op gelijktijdige wijzigingen.

Voorbeeld: 1

Aanvullende velden: Nee

Bijwerken — Producten — Verzoekinhoud

ProductUpdate · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.
brand_idTekenreeks nullOptioneel

Merkidentificatie.

Tekenreeks:minLength: 1maxLength: 63
conditionTekenreeksOptioneel

Conditie van het product.

Beperkingen
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
descriptionTekenreeks nullOptioneel

Beschrijving in de geselecteerde taal.

Tekenreeks:maxLength: 100000
Voorbeeld: null
expected_variant_price_versionsObjectAanvullende velden: Geheel getal
minimum: 0maximum: 9223372036854775807
Optioneel

Eerder gelezen prijsversies, met de variantidentificatie als sleutel.

maxProperties: 250
Beperkingen
propertyNames
{"maxLength": 63, "minLength": 1}
expected_versionGeheel getalVerplicht

Versie die vóór de schrijfbewerking is gelezen; bij afwijking wordt de wijziging geweigerd.

minimum: 1maximum: 9223372036854775807
Voorbeeld: 1
feature_value_idsArray <Tekenreeks> Optioneel

Identificaties van geselecteerde kenmerkwaarden.

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

Productidentificatiecodes.

market_idsArray <Tekenreeks> Optioneel

Identificaties van geselecteerde markten.

maxItems: 1000
Array:minLength: 1maxLength: 63
media_idsArray <Tekenreeks> Optioneel

Identificaties van bestaande mediabestanden.

maxItems: 20
Array:minLength: 1maxLength: 63
meta_descriptionTekenreeks nullOptioneel

Zoekmachinebeschrijving in de geselecteerde taal.

Tekenreeks:maxLength: 160
meta_keywordsArray <Tekenreeks> nullOptioneel

Zoekmachinetrefwoorden in de geselecteerde taal.

Array:maxItems: 20
Array / Array:maxLength: 50
meta_titleTekenreeks nullOptioneel

Zoekmachinetitel in de geselecteerde taal.

Tekenreeks:maxLength: 70
nameTekenreeks nullOptioneel

Resourcenaam in de betreffende context.

Tekenreeks:maxLength: 300
Voorbeeld: null
pricingProductPrice Optioneel

Prijsconfiguratie en versies voor gelijktijdige wijzigingen.

Voorbeeld: {"amount":"0.00","currency":"PLN","expected_price_list_version":1,"expected_version":0,"kind":"base","price_list_id":"example","tax_included":true}
primary_category_idTekenreeks nullOptioneel

Identificatie van de primaire categorie.

Tekenreeks:minLength: 1maxLength: 63
publishedBooleaanse waardeOptioneel

Of de resource is gepubliceerd.

skuTekenreeksOptioneel

Voorraadartikelcode (SKU).

minLength: 1maxLength: 100
Beperkingen
pattern
"^\\S+$"
Voorbeeld: "example"
slugTekenreeks nullOptioneel

URL-padsegment in de geselecteerde taal.

Tekenreeks:maxLength: 160
tax_category_idTekenreeks nullOptioneel

Identificatie van de belastingcategorie.

Tekenreeks:minLength: 1maxLength: 63
variant_value_idsArray <Tekenreeks> Optioneel

Identificaties van geselecteerde variantwaarden.

maxItems: 250
Array:minLength: 1maxLength: 63
variants_enabledBooleaanse waardeOptioneel

Of het product varianten gebruikt.

Aanvullende velden: Nee