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

ApiResponse_ProductFileListData_

ApiResponse_ProductFileListData_ · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft. Upload bestanden als multipart/form-data na het aanmaken van upload_id en koppel ze daarna aan het product. Downloaden vereist een Bearer-token en toestemming voor category; de respons bevat bestandsbytes, zonder openbaar adres of wachtwoord. Kies bij mode=period days (1–3650) of de bestaande months, nooit beide. Voorwaarden worden bij aankoop vastgelegd; een terugbetaling trekt alleen de toegang voor de terugbetaalde regel in.
dataProductFileListData Verplicht

Gegevens van een geslaagd antwoord.

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

Metadata van het antwoord.

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

Aanvullende velden: Nee

ApiResponse_ReleaseListData_

ApiResponse_ReleaseListData_ · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft. Upload bestanden als multipart/form-data na het aanmaken van upload_id en koppel ze daarna aan het product. Downloaden vereist een Bearer-token en toestemming voor category; de respons bevat bestandsbytes, zonder openbaar adres of wachtwoord. Kies bij mode=period days (1–3650) of de bestaande months, nooit beide. Voorwaarden worden bij aankoop vastgelegd; een terugbetaling trekt alleen de toegang voor de terugbetaalde regel in.
dataReleaseListData Verplicht

Gegevens van een geslaagd antwoord.

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

Metadata van het antwoord.

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

Aanvullende velden: Nee

ApiResponse_UploadData_

ApiResponse_UploadData_ · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft. Upload bestanden als multipart/form-data na het aanmaken van upload_id en koppel ze daarna aan het product. Downloaden vereist een Bearer-token en toestemming voor category; de respons bevat bestandsbytes, zonder openbaar adres of wachtwoord. Kies bij mode=period days (1–3650) of de bestaande months, nooit beide. Voorwaarden worden bij aankoop vastgelegd; een terugbetaling trekt alleen de toegang voor de terugbetaalde regel in.
dataUploadData Verplicht

Gegevens van een geslaagd antwoord.

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

Metadata van het antwoord.

Voorbeeld: {"request_id":"example"}

Aanvullende velden: Nee

ApiResponse[AudienceData]

ApiResponse_AudienceData_ · Lees de toegangsregel en productversie. De eerste publicatie blijft het tijdsanker.
dataAudienceData Verplicht

Gegevens van een geslaagd antwoord.

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

Metadata van het antwoord.

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

Aanvullende velden: Nee

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

AudienceChange

AudienceChange · Kies geldige aankopen. Geselecteerde bestellingen moeten dit product betaald en niet terugbetaald bevatten.
audienceAudienceSelection Verplicht

Expliciete toegangsregel voor het gedeelde bestand.

Voorbeeld: {"mode":"all_purchasers"}
expected_versionGeheel getalVerplicht

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

minimum: 1maximum: 9223372036854775807
Voorbeeld: 1

Aanvullende velden: Nee

AudienceData

AudienceData · Lees de toegangsregel en productversie. De eerste publicatie blijft het tijdsanker.
anchor_atTekenreeksVerplicht

Eerste publicatie; verandert niet bij een nieuwe regel.

format: "date-time"
Voorbeeld: "2026-11-03T12:00:00Z"
effective_atTekenreeksVerplicht

Publicatietijd van deze toegangsregel.

format: "date-time"
Voorbeeld: "2026-11-03T12:00:00Z"
file_idTekenreeksVerplicht

Resource-identificatie; bewaar deze zoals teruggegeven. · file_id

Voorbeeld: "00000000-0000-4000-8000-000000000007"
file_version_idTekenreeksVerplicht

ID van een onveranderlijke bestandsversie.

Voorbeeld: "00000000-0000-4000-8000-000000000010"
historical_access_preservedBooleaanse waardeOptioneel

Eerder verleende rechten blijven bij beperking van de regel bestaan.

Standaard: trueVoorbeeld: true
idTekenreeksVerplicht

Resource-identificatie; bewaar deze zoals teruggegeven.

Voorbeeld: "00000000-0000-4000-8000-000000000009"
lookback_daysGeheel getal nullVerplicht

1–3650 dagen vóór eerste publicatie; alleen recent_and_new.

Voorbeeld: null
modeTekenreeksVerplicht

Expliciete toegangsregel voor het gedeelde bestand. new_purchases / recent_and_new / selected / all_purchasers.

Voorbeeld: "all_purchasers"
next_cursorTekenreeks nullVerplicht

Vervolgwaarde voor de volgende pagina, of null.

Voorbeeld: null
order_idsArray <Tekenreeks> Verplicht

Bestellingen met dit betaalde, niet terugbetaalde product.

Voorbeeld: []
product_versionGeheel getalVerplicht

Huidige productversie voor controle op gelijktijdige wijzigingen.

Voorbeeld: 3
revisionGeheel getalVerplicht

Opeenvolgende revisie van de toegangsregel.

Voorbeeld: 1

Aanvullende velden: Nee

AudienceSelection

AudienceSelection · Kies geldige aankopen. Geselecteerde bestellingen moeten dit product betaald en niet terugbetaald bevatten.
lookback_daysGeheel getal nullOptioneel

1–3650 dagen vóór eerste publicatie; alleen recent_and_new.

Geheel getal:minimum: 1maximum: 3650
modeTekenreeksVerplicht

Expliciete toegangsregel voor het gedeelde bestand. new_purchases / recent_and_new / selected / all_purchasers.

Beperkingen
enum
["new_purchases", "recent_and_new", "selected", "all_purchasers"]
Voorbeeld: "new_purchases"
order_idsArray <Tekenreeks> Optioneel

Bestellingen met dit betaalde, niet terugbetaalde product.

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

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

FileAssign

FileAssign · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft. Upload bestanden als multipart/form-data na het aanmaken van upload_id en koppel ze daarna aan het product. Downloaden vereist een Bearer-token en toestemming voor category; de respons bevat bestandsbytes, zonder openbaar adres of wachtwoord. Kies bij mode=period days (1–3650) of de bestaande months, nooit beide. Voorwaarden worden bij aankoop vastgelegd; een terugbetaling trekt alleen de toegang voor de terugbetaalde regel in.
audienceAudienceSelection nullOptioneel

Expliciete toegangsregel voor het gedeelde bestand.

Voorbeeld: {"mode":"new_purchases"}
expected_versionGeheel getalVerplicht

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

minimum: 1maximum: 9223372036854775807
Voorbeeld: 1
labelTekenreeksOptioneel

Resourcenaam in de betreffende context.

maxLength: 300
Standaard: ""
upload_idTekenreeksVerplicht

Resource-identificatie; bewaar deze zoals teruggegeven. · upload_id

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

Aanvullende velden: Nee

FileCategory

FileCategory · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft. Upload bestanden als multipart/form-data na het aanmaken van upload_id en koppel ze daarna aan het product. Downloaden vereist een Bearer-token en toestemming voor category; de respons bevat bestandsbytes, zonder openbaar adres of wachtwoord. Kies bij mode=period days (1–3650) of de bestaande months, nooit beide. Voorwaarden worden bij aankoop vastgelegd; een terugbetaling trekt alleen de toegang voor de terugbetaalde regel in.
Tekenreeks
Beperkingen
enum
["internal", "customer_document", "digital"]

Aanvullende velden: Ja

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

ProductFileData

ProductFileData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft. Upload bestanden als multipart/form-data na het aanmaken van upload_id en koppel ze daarna aan het product. Downloaden vereist een Bearer-token en toestemming voor category; de respons bevat bestandsbytes, zonder openbaar adres of wachtwoord. Kies bij mode=period days (1–3650) of de bestaande months, nooit beide. Voorwaarden worden bij aankoop vastgelegd; een terugbetaling trekt alleen de toegang voor de terugbetaalde regel in.
categoryFileCategory Verplicht

Bestandscategorie: internal / customer_document / digital

Voorbeeld: "digital"
created_atTekenreeksVerplicht

Tijdstip van aanmaak.

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

Resource-identificatie; bewaar deze zoals teruggegeven. · current_version_id

format: "uuid"
Voorbeeld: "00000000-0000-4000-8000-000000000001"
file_idTekenreeksVerplicht

Resource-identificatie; bewaar deze zoals teruggegeven. · file_id

format: "uuid"
Voorbeeld: "00000000-0000-4000-8000-000000000001"
filenameTekenreeksVerplicht

Bestand

Voorbeeld: "manual.pdf"
idTekenreeksVerplicht

Resource-identificatie; bewaar deze zoals teruggegeven.

format: "uuid"
Voorbeeld: "00000000-0000-4000-8000-000000000001"
labelTekenreeksVerplicht

Resourcenaam in de betreffende context.

Voorbeeld: "Manual"
mime_typeTekenreeksVerplicht

Inhoudstype van de media.

Voorbeeld: "application/pdf"
sha256TekenreeksVerplicht

SHA-256 (hex, 64)

Voorbeeld: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesGeheel getalVerplicht

Grootte in bytes

Voorbeeld: 46
stateTekenreeksVerplicht

Status

Voorbeeld: "active"
version_numberGeheel getalVerplicht

Versie

Voorbeeld: 1

Aanvullende velden: Nee

ProductFileListData

ProductFileListData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft. Upload bestanden als multipart/form-data na het aanmaken van upload_id en koppel ze daarna aan het product. Downloaden vereist een Bearer-token en toestemming voor category; de respons bevat bestandsbytes, zonder openbaar adres of wachtwoord. Kies bij mode=period days (1–3650) of de bestaande months, nooit beide. Voorwaarden worden bij aankoop vastgelegd; een terugbetaling trekt alleen de toegang voor de terugbetaalde regel in.
filesArray <ProductFileData > Verplicht

Productbestanden

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

Huidige productversie voor controle op gelijktijdige wijzigingen.

Voorbeeld: 2

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

ProductVersion

ProductVersion · Deze bewerking is beëindigd en geeft 409 zonder gegevens te wijzigen. Stel toegang per digitaal bestand in via de keuze van ontvangers.
expected_versionGeheel getalVerplicht

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

minimum: 1maximum: 9223372036854775807
Voorbeeld: 1

Aanvullende velden: Nee

ReleaseData

ReleaseData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft. Upload bestanden als multipart/form-data na het aanmaken van upload_id en koppel ze daarna aan het product. Downloaden vereist een Bearer-token en toestemming voor category; de respons bevat bestandsbytes, zonder openbaar adres of wachtwoord. Kies bij mode=period days (1–3650) of de bestaande months, nooit beide. Voorwaarden worden bij aankoop vastgelegd; een terugbetaling trekt alleen de toegang voor de terugbetaalde regel in.
changelogTekenreeksVerplicht

Beschrijving van wijzigingen

Voorbeeld: "Manual update"
filesArray <ReleaseFileData > Verplicht

Productbestanden

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

Resource-identificatie; bewaar deze zoals teruggegeven.

format: "uuid"
Voorbeeld: "00000000-0000-4000-8000-000000000001"
manifest_sha256Tekenreeks nullVerplicht

Digitale uitgaven · SHA-256

Voorbeeld: "1111111111111111111111111111111111111111111111111111111111111111"
published_atTekenreeks nullVerplicht

Uitgave publiceren · UTC

Tekenreeks:format: "date-time"
Voorbeeld: null
release_sequenceGeheel getal nullVerplicht

Digitale uitgaven · Positie in de geordende verzameling.

Voorbeeld: null
stateTekenreeksVerplicht

Status

Voorbeeld: "active"
version_labelTekenreeksVerplicht

Versie

Voorbeeld: "1.0"
withdrawn_atTekenreeks nullVerplicht

Aanbod intrekken · UTC

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

Aanvullende velden: Nee

ReleaseDraft

ReleaseDraft · Deze bewerking is beëindigd en geeft 409 zonder gegevens te wijzigen. Stel toegang per digitaal bestand in via de keuze van ontvangers.
changelogTekenreeksOptioneel

Beschrijving van wijzigingen

maxLength: 20000
Standaard: ""
expected_versionGeheel getalVerplicht

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

minimum: 1maximum: 9223372036854775807
Voorbeeld: 1
version_idsArray <Tekenreeks> Verplicht

Versie · UUID[]

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

Versie

minLength: 1maxLength: 64
Voorbeeld: "1.0"

Aanvullende velden: Nee

ReleaseFileData

ReleaseFileData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft. Upload bestanden als multipart/form-data na het aanmaken van upload_id en koppel ze daarna aan het product. Downloaden vereist een Bearer-token en toestemming voor category; de respons bevat bestandsbytes, zonder openbaar adres of wachtwoord. Kies bij mode=period days (1–3650) of de bestaande months, nooit beide. Voorwaarden worden bij aankoop vastgelegd; een terugbetaling trekt alleen de toegang voor de terugbetaalde regel in.
file_idTekenreeksVerplicht

Resource-identificatie; bewaar deze zoals teruggegeven. · file_id

format: "uuid"
Voorbeeld: "00000000-0000-4000-8000-000000000001"
sort_orderGeheel getalVerplicht

Positie in de geordende verzameling.

Voorbeeld: 0
version_idTekenreeksVerplicht

Resource-identificatie; bewaar deze zoals teruggegeven. · version_id

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

Aanvullende velden: Nee

ReleaseListData

ReleaseListData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft. Upload bestanden als multipart/form-data na het aanmaken van upload_id en koppel ze daarna aan het product. Downloaden vereist een Bearer-token en toestemming voor category; de respons bevat bestandsbytes, zonder openbaar adres of wachtwoord. Kies bij mode=period days (1–3650) of de bestaande months, nooit beide. Voorwaarden worden bij aankoop vastgelegd; een terugbetaling trekt alleen de toegang voor de terugbetaalde regel in.
current_release_idTekenreeks nullVerplicht

Resource-identificatie; bewaar deze zoals teruggegeven. · current_release_id

Tekenreeks:format: "uuid"
Voorbeeld: "00000000-0000-4000-8000-000000000001"
product_versionGeheel getalVerplicht

Huidige productversie voor controle op gelijktijdige wijzigingen.

Voorbeeld: 2
releasesArray <ReleaseData > Verplicht

Digitale uitgaven

Voorbeeld: [{"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_daysGeheel getal nullVerplicht

Aantal dagen (days; null)

Voorbeeld: 365
update_modeTekenreeksVerplicht

Toegang tot toekomstige bestanden na aankoop: none / period / unlimited

Voorbeeld: "period"
update_monthsGeheel getal nullVerplicht

Maanden (months; null)

Voorbeeld: null

Aanvullende velden: Nee

UpdatePolicy

UpdatePolicy · Deze bewerking is beëindigd en geeft 409 zonder gegevens te wijzigen. Stel toegang per digitaal bestand in via de keuze van ontvangers.
daysGeheel getal nullOptioneel

Aantal dagen (1–3650; mode=period; months=null)

Geheel getal:minimum: 1maximum: 3650
Voorbeeld: 365
expected_versionGeheel getalVerplicht

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

minimum: 1maximum: 9223372036854775807
Voorbeeld: 1
modeTekenreeksVerplicht

Toegang tot toekomstige bestanden na aankoop: none / period / unlimited

Beperkingen
enum
["none", "period", "unlimited"]
Voorbeeld: "period"
monthsGeheel getal nullOptioneel

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

Geheel getal:minimum: 1maximum: 120
Voorbeeld: null

Aanvullende velden: Nee

UploadCreate

UploadCreate · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft. Upload bestanden als multipart/form-data na het aanmaken van upload_id en koppel ze daarna aan het product. Downloaden vereist een Bearer-token en toestemming voor category; de respons bevat bestandsbytes, zonder openbaar adres of wachtwoord. Kies bij mode=period days (1–3650) of de bestaande months, nooit beide. Voorwaarden worden bij aankoop vastgelegd; een terugbetaling trekt alleen de toegang voor de terugbetaalde regel in.
filenameTekenreeksVerplicht

Bestand

minLength: 1maxLength: 255
Voorbeeld: "manual.pdf"
product_idTekenreeks nullOptioneel

Productidentificatie.

Beperkingen · Tekenreeks 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Voorbeeld: "example"
sha256TekenreeksVerplicht

SHA-256 (hex, 64)

Beperkingen
pattern
"^[0-9a-f]{64}$"
Voorbeeld: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesGeheel getalVerplicht

Grootte in bytes

minimum: 1maximum: 262144000
Voorbeeld: 46

Aanvullende velden: Nee

UploadData

UploadData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft. Upload bestanden als multipart/form-data na het aanmaken van upload_id en koppel ze daarna aan het product. Downloaden vereist een Bearer-token en toestemming voor category; de respons bevat bestandsbytes, zonder openbaar adres of wachtwoord. Kies bij mode=period days (1–3650) of de bestaande months, nooit beide. Voorwaarden worden bij aankoop vastgelegd; een terugbetaling trekt alleen de toegang voor de terugbetaalde regel in.
categoryFileCategory Verplicht

Bestandscategorie: internal / customer_document / digital

Voorbeeld: "digital"
expires_atTekenreeksVerplicht

Datum en tijd waarop het toegangsbewijs verloopt.

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

Bestand

Voorbeeld: "manual.pdf"
idTekenreeksVerplicht

Resource-identificatie; bewaar deze zoals teruggegeven.

format: "uuid"
Voorbeeld: "00000000-0000-4000-8000-000000000001"
product_idTekenreeks nullVerplicht

Productidentificatie.

Voorbeeld: "example"
received_bytesGeheel getalVerplicht

Uploaden… · Grootte in bytes

Voorbeeld: 46
sha256TekenreeksVerplicht

SHA-256 (hex, 64)

Voorbeeld: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesGeheel getalVerplicht

Grootte in bytes

Voorbeeld: 46
statusTekenreeksVerplicht

Status die deze specifieke bewerking accepteert.

Voorbeeld: "ready"

Aanvullende velden: Nee