Gegevensschema’s
Lijst ophalen — Producten — Antwoord
ApiResponse_list_ProductSummaryData__ · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.
dataArray <ProductSummaryData> VerplichtVoorbeeldantwoord · ApiResponse_list_ProductSummaryData__.
metaContextPageMetaContextMetaPageMetaRequestMetaVerplichtMetadata van het antwoord.
Aanvullende velden: Nee
Ophalen — Producten — Antwoord
ApiResponse_ProductDetailData_ · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.
dataProductDetailDataVerplichtVoorbeeldantwoord · ProductDetailData.
metaContextPageMetaContextMetaPageMetaRequestMetaVerplichtMetadata van het antwoord.
Aanvullende velden: Nee
Beschikbaarheid in de geselecteerde context
AvailabilityData · Schema · Gegevensschema’s: Producten
available_fromTekenreeks nullVerplichtBegin van de beschikbaarheid.
Tekenreeks:format:"date-time"available_untilTekenreeks nullVerplichtEinde van de beschikbaarheid.
Tekenreeks:format:"date-time"is_availableBooleaanse waardeVerplichtOf het item beschikbaar is in deze context.
Aanvullende velden: Nee
Prijsgegevens in de geselecteerde context
PriceData · Schema · Gegevensschema’s: Producten
amountTekenreeksVerplichtDecimaal bedrag als JSON-tekenreeks; null uitsluitend waar toegestaan.
currencyTekenreeksVerplichtValutacode voor het bedrag.
Beperkingen
pattern"^[A-Z]{3}$"
minor_unitsGeheel getalVerplichtAantal decimalen van de valuta.
minimum:0maximum:4tax_includedBooleaanse waardeVerplichtOf de opgegeven prijs inclusief belasting is.
Aanvullende velden: Nee
Prijslijstgegevens
PriceListData · Schema · Gegevensschema’s: Producten
currencyTekenreeksVerplichtValutacode voor het bedrag.
idTekenreeksVerplichtResource-identificatie; bewaar deze zoals teruggegeven. (PriceListData).
tax_includedBooleaanse waardeVerplichtOf de opgegeven prijs inclusief belasting is.
versionGeheel getalVerplichtResourceversie 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 nullOptioneelMerkidentificatie.
Tekenreeks:minLength:1maxLength:63conditionTekenreeksOptioneelConditie van het product.
Beperkingen
enum["new", "refurbished", "used", "returned", "display", "damaged"]
descriptionTekenreeks nullOptioneelBeschrijving in de geselecteerde taal.
Tekenreeks:maxLength:100000feature_value_idsArray <Tekenreeks> OptioneelIdentificaties van geselecteerde kenmerkwaarden.
maxItems:1000Array:minLength:1maxLength:63identifiersProductIdentifiersnullOptioneelProductidentificatiecodes.
market_idsArray <Tekenreeks> OptioneelIdentificaties van geselecteerde markten.
maxItems:1000Array:minLength:1maxLength:63media_idsArray <Tekenreeks> OptioneelIdentificaties van bestaande mediabestanden.
maxItems:20Array:minLength:1maxLength:63meta_descriptionTekenreeks nullOptioneelZoekmachinebeschrijving in de geselecteerde taal.
Tekenreeks:maxLength:160meta_keywordsArray <Tekenreeks> nullOptioneelZoekmachinetrefwoorden in de geselecteerde taal.
Array:maxItems:20Array / Array:maxLength:50meta_titleTekenreeks nullOptioneelZoekmachinetitel in de geselecteerde taal.
Tekenreeks:maxLength:70nameTekenreeksVerplichtResourcenaam in de betreffende context.
minLength:1maxLength:300pricingProductPriceOptioneelPrijsconfiguratie en versies voor gelijktijdige wijzigingen.
primary_category_idTekenreeks nullOptioneelIdentificatie van de primaire categorie.
Tekenreeks:minLength:1maxLength:63publishedBooleaanse waardeOptioneelOf de resource is gepubliceerd.
skuTekenreeksVerplichtVoorraadartikelcode (SKU).
minLength:1maxLength:100Beperkingen
pattern"^\\S+$"
slugTekenreeks nullOptioneelURL-padsegment in de geselecteerde taal.
Tekenreeks:maxLength:160tax_category_idTekenreeks nullOptioneelIdentificatie van de belastingcategorie.
Tekenreeks:minLength:1maxLength:63variant_value_idsArray <Tekenreeks> OptioneelIdentificaties van geselecteerde variantwaarden.
maxItems:250Array:minLength:1maxLength:63variants_enabledBooleaanse waardeOptioneelOf het product varianten gebruikt.
Aanvullende velden: Nee
Ophalen — Producten — Antwoord
ProductDetailData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.
availabilityAvailabilityDataVerplichtBeschikbaarheid in de geselecteerde context.
brand_idTekenreeks nullVerplichtMerkidentificatie.
conditionTekenreeksVerplichtConditie van het product.
Beperkingen
enum["new", "refurbished", "used", "returned", "display", "damaged"]
created_atTekenreeksVerplichtTijdstip van aanmaak.
format:"date-time"descriptionTekenreeks nullVerplichtBeschrijving in de geselecteerde taal.
featuresArray <FeatureSelectionData> VerplichtProductkenmerken.
idTekenreeksVerplichtResource-identificatie; bewaar deze zoals teruggegeven. (ProductDetailData).
identifiersObjectAanvullende velden: TekenreeksVerplichtProductidentificatiecodes.
mediaArray <ProductMediaData> VerplichtInformatie over gekoppelde media.
meta_descriptionTekenreeks nullVerplichtZoekmachinebeschrijving in de geselecteerde taal.
meta_keywordsArray <Tekenreeks> nullVerplichtZoekmachinetrefwoorden in de geselecteerde taal.
meta_titleTekenreeks nullVerplichtZoekmachinetitel in de geselecteerde taal.
nameTekenreeks nullVerplichtResourcenaam in de betreffende context.
numberTekenreeksVerplichtBestel- of aanvraagnummer voor menselijk gebruik.
pricePriceDatanullVerplichtPrijsgegevens in de geselecteerde context.
price_versionGeheel getalVerplichtHuidige prijsversie voor controle op gelijktijdige wijzigingen.
primary_category_idTekenreeks nullVerplichtIdentificatie van de primaire categorie.
primary_media_idTekenreeks nullVerplichtIdentificatie van het primaire mediabestand.
publishedBooleaanse waardeVerplichtOf de resource is gepubliceerd.
skuTekenreeksVerplichtVoorraadartikelcode (SKU).
slugTekenreeks nullVerplichtURL-padsegment in de geselecteerde taal.
tax_category_idTekenreeksVerplichtIdentificatie van de belastingcategorie.
updated_atTekenreeksVerplichtTijdstip van de meest recente wijziging.
format:"date-time"variants_enabledBooleaanse waardeVerplichtOf het product varianten gebruikt.
versionGeheel getalVerplichtResourceversie voor controle op gelijktijdige wijzigingen.
Aanvullende velden: Nee
Productidentificatiecodes
ProductIdentifiers · Schema · Gegevensschema’s: Producten
eanTekenreeks nullOptioneelEAN-productidentificatie.
Tekenreeks:minLength:1maxLength:100isbnTekenreeks nullOptioneelISBN-identificatie.
Tekenreeks:minLength:1maxLength:100mpnTekenreeks nullOptioneelOnderdeelnummer van de fabrikant.
Tekenreeks:minLength:1maxLength:100upcTekenreeks nullOptioneelUPC-productidentificatie.
Tekenreeks:minLength:1maxLength:100
Aanvullende velden: Nee
Informatie over gekoppelde media
ProductMediaData · Schema · Gegevensschema’s: Producten
alt_textTekenreeks nullVerplichtAlternatieve tekst voor een afbeelding.
idTekenreeksVerplichtResource-identificatie; bewaar deze zoals teruggegeven. (ProductMediaData).
is_primaryBooleaanse waardeVerplichtOf dit het primaire item is.
kindTekenreeksVerplichtVariant van de gegevensstructuur, zoals beschreven door de toegestane waarden.
Beperkingen
enum["image", "video", "model_3d"]
mime_typeTekenreeksVerplichtInhoudstype van de media.
positionGeheel getalVerplichtPositie in de geordende verzameling.
urlTekenreeks nullVerplichtResource-URL.
Aanvullende velden: Nee
Prijsconfiguratie en versies voor gelijktijdige wijzigingen
ProductPrice · Schema · Gegevensschema’s: Producten
amountTekenreeks nullVerplichtDecimaal bedrag als JSON-tekenreeks; null uitsluitend waar toegestaan.
Tekenreeks:maxLength:19Beperkingen · Tekenreeks 1
pattern"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
currencyTekenreeksVerplichtValutacode voor het bedrag.
Beperkingen
pattern"^[A-Z]{3}$"
expected_price_list_versionGeheel getalVerplichtEerder gelezen prijslijstversie die voor deze schrijfbewerking vereist is.
minimum:1maximum:9223372036854775807expected_versionGeheel getalVerplichtVersie die vóór de schrijfbewerking is gelezen; bij afwijking wordt de wijziging geweigerd.
minimum:0maximum:9223372036854775807kindTekenreeksVerplichtVariant van de gegevensstructuur, zoals beschreven door de toegestane waarden.
Beperkingen
enum["base", "market_fixed"]
price_list_idTekenreeksVerplichtPrijslijstidentificatie.
minLength:1maxLength:63tax_includedBooleaanse waardeVerplichtOf de opgegeven prijs inclusief belasting is.
Aanvullende velden: Nee
Lijst ophalen — Producten — Antwoord
ProductSummaryData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.
availabilityAvailabilityDataVerplichtBeschikbaarheid in de geselecteerde context.
brand_idTekenreeks nullVerplichtMerkidentificatie.
conditionTekenreeksVerplichtConditie van het product.
Beperkingen
enum["new", "refurbished", "used", "returned", "display", "damaged"]
created_atTekenreeksVerplichtTijdstip van aanmaak.
format:"date-time"idTekenreeksVerplichtResource-identificatie; bewaar deze zoals teruggegeven. (ProductSummaryData).
nameTekenreeks nullVerplichtResourcenaam in de betreffende context.
numberTekenreeksVerplichtBestel- of aanvraagnummer voor menselijk gebruik.
pricePriceDatanullVerplichtPrijsgegevens in de geselecteerde context.
price_versionGeheel getalVerplichtHuidige prijsversie voor controle op gelijktijdige wijzigingen.
primary_category_idTekenreeks nullVerplichtIdentificatie van de primaire categorie.
primary_media_idTekenreeks nullVerplichtIdentificatie van het primaire mediabestand.
publishedBooleaanse waardeVerplichtOf de resource is gepubliceerd.
skuTekenreeksVerplichtVoorraadartikelcode (SKU).
slugTekenreeks nullVerplichtURL-padsegment in de geselecteerde taal.
tax_category_idTekenreeksVerplichtIdentificatie van de belastingcategorie.
updated_atTekenreeksVerplichtTijdstip van de meest recente wijziging.
format:"date-time"variants_enabledBooleaanse waardeVerplichtOf het product varianten gebruikt.
versionGeheel getalVerplichtResourceversie voor controle op gelijktijdige wijzigingen.
Aanvullende velden: Nee
Bijwerken — Producten — Verzoekinhoud
ProductUpdate · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.
brand_idTekenreeks nullOptioneelMerkidentificatie.
Tekenreeks:minLength:1maxLength:63conditionTekenreeksOptioneelConditie van het product.
Beperkingen
enum["new", "refurbished", "used", "returned", "display", "damaged"]
descriptionTekenreeks nullOptioneelBeschrijving in de geselecteerde taal.
Tekenreeks:maxLength:100000expected_variant_price_versionsObjectAanvullende velden: Geheel getalOptioneelminimum:0maximum:9223372036854775807Eerder gelezen prijsversies, met de variantidentificatie als sleutel.
maxProperties:250Beperkingen
propertyNames{"maxLength": 63, "minLength": 1}
expected_versionGeheel getalVerplichtVersie die vóór de schrijfbewerking is gelezen; bij afwijking wordt de wijziging geweigerd.
minimum:1maximum:9223372036854775807feature_value_idsArray <Tekenreeks> OptioneelIdentificaties van geselecteerde kenmerkwaarden.
maxItems:1000Array:minLength:1maxLength:63identifiersProductIdentifiersnullOptioneelProductidentificatiecodes.
market_idsArray <Tekenreeks> OptioneelIdentificaties van geselecteerde markten.
maxItems:1000Array:minLength:1maxLength:63media_idsArray <Tekenreeks> OptioneelIdentificaties van bestaande mediabestanden.
maxItems:20Array:minLength:1maxLength:63meta_descriptionTekenreeks nullOptioneelZoekmachinebeschrijving in de geselecteerde taal.
Tekenreeks:maxLength:160meta_keywordsArray <Tekenreeks> nullOptioneelZoekmachinetrefwoorden in de geselecteerde taal.
Array:maxItems:20Array / Array:maxLength:50meta_titleTekenreeks nullOptioneelZoekmachinetitel in de geselecteerde taal.
Tekenreeks:maxLength:70nameTekenreeks nullOptioneelResourcenaam in de betreffende context.
Tekenreeks:maxLength:300pricingProductPriceOptioneelPrijsconfiguratie en versies voor gelijktijdige wijzigingen.
primary_category_idTekenreeks nullOptioneelIdentificatie van de primaire categorie.
Tekenreeks:minLength:1maxLength:63publishedBooleaanse waardeOptioneelOf de resource is gepubliceerd.
skuTekenreeksOptioneelVoorraadartikelcode (SKU).
minLength:1maxLength:100Beperkingen
pattern"^\\S+$"
slugTekenreeks nullOptioneelURL-padsegment in de geselecteerde taal.
Tekenreeks:maxLength:160tax_category_idTekenreeks nullOptioneelIdentificatie van de belastingcategorie.
Tekenreeks:minLength:1maxLength:63variant_value_idsArray <Tekenreeks> OptioneelIdentificaties van geselecteerde variantwaarden.
maxItems:250Array:minLength:1maxLength:63variants_enabledBooleaanse waardeOptioneelOf het product varianten gebruikt.
Aanvullende velden: Nee