Gå til innhold
ShopentlyLearn

Dataskjemaer: Produkter

Dataskjemaer: Produkter. Felter, typer og begrensninger for data som API-et mottar eller returnerer.

Dataskjemaer

Vis liste — Produkter — Svar

ApiResponse_list_ProductSummaryData__ · Felter, typer og begrensninger for data som API-et mottar eller returnerer.
dataArray <ProductSummaryData > Obligatorisk

Eksempel på svar · ApiResponse_list_ProductSummaryData__.

Eksempel: [{"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 Obligatorisk

Svarmetadata.

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

Ytterligere felt: Nei

Hent — Produkter — Svar

ApiResponse_ProductDetailData_ · Felter, typer og begrensninger for data som API-et mottar eller returnerer.
dataProductDetailData Obligatorisk

Eksempel på svar · ProductDetailData.

Eksempel: {"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 Obligatorisk

Svarmetadata.

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

Ytterligere felt: Nei

Tilgjengelighetsinformasjon for valgt kontekst

AvailabilityData · Skjema · Dataskjemaer: Produkter
available_fromStreng nullObligatorisk

Start på tilgjengelighetsperioden.

Streng:format: "date-time"
Eksempel: null
available_untilStreng nullObligatorisk

Slutt på tilgjengelighetsperioden.

Streng:format: "date-time"
Eksempel: null
is_availableBoolsk verdiObligatorisk

Om varen er tilgjengelig i denne konteksten.

Eksempel: true

Ytterligere felt: Nei

Prisinformasjon i valgt kontekst

PriceData · Skjema · Dataskjemaer: Produkter
amountStrengObligatorisk

Desimalbeløp kodet som en JSON-streng; null bare der det er tillatt.

Eksempel: "0.00"
currencyStrengObligatorisk

Valutakode for beløpet.

Begrensninger
pattern
"^[A-Z]{3}$"
Eksempel: "PLN"
minor_unitsHeltallObligatorisk

Antall desimalsifre valutaen bruker.

minimum: 0maximum: 4
Eksempel: 2
tax_includedBoolsk verdiObligatorisk

Om innsendt pris inkluderer avgifter.

Eksempel: true

Ytterligere felt: Nei

Prislisteinformasjon

PriceListData · Skjema · Dataskjemaer: Produkter
currencyStrengObligatorisk

Valutakode for beløpet.

idStrengObligatorisk

Ressursidentifikator; behold den slik den returneres. (PriceListData).

tax_includedBoolsk verdiObligatorisk

Om innsendt pris inkluderer avgifter.

versionHeltallObligatorisk

Ressursversjon brukt til samtidighetskontroll.

Ytterligere felt: Nei

Opprett — Produkter — Forespørselsinnhold

ProductCreate · Felter, typer og begrensninger for data som API-et mottar eller returnerer.
brand_idStreng nullValgfritt

Merkeidentifikator.

Streng:minLength: 1maxLength: 63
conditionStrengValgfritt

Produktets tilstand.

Begrensninger
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Standard: "new"
descriptionStreng nullValgfritt

Beskrivelse på valgt språk.

Streng:maxLength: 100000
feature_value_idsArray <Streng> Valgfritt

Identifikatorer for valgte egenskapsverdier.

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

Produktidentifikasjonskoder.

market_idsArray <Streng> Valgfritt

Identifikatorer for valgte markeder.

maxItems: 1000
Array:minLength: 1maxLength: 63
media_idsArray <Streng> Valgfritt

Identifikatorer for medier som allerede finnes.

maxItems: 20
Array:minLength: 1maxLength: 63
meta_descriptionStreng nullValgfritt

Søkemotorbeskrivelse på valgt språk.

Streng:maxLength: 160
meta_keywordsArray <Streng> nullValgfritt

Søkemotornøkkelord på valgt språk.

Array:maxItems: 20
Array / Array:maxLength: 50
meta_titleStreng nullValgfritt

Søkemotortittel på valgt språk.

Streng:maxLength: 70
nameStrengObligatorisk

Ressursens navn i den relevante konteksten.

minLength: 1maxLength: 300
Eksempel: "Example"
pricingProductPrice Valgfritt

Priskonfigurasjon og versjonene for samtidighetskontroll.

primary_category_idStreng nullValgfritt

Identifikator for primærkategori.

Streng:minLength: 1maxLength: 63
publishedBoolsk verdiValgfritt

Om ressursen er publisert.

Standard: false
skuStrengObligatorisk

SKU-varekode.

minLength: 1maxLength: 100
Begrensninger
pattern
"^\\S+$"
Eksempel: "example"
slugStreng nullValgfritt

URL-stisegment på valgt språk.

Streng:maxLength: 160
tax_category_idStreng nullValgfritt

Identifikator for avgiftskategori.

Streng:minLength: 1maxLength: 63
variant_value_idsArray <Streng> Valgfritt

Identifikatorer for valgte variantverdier.

maxItems: 250
Array:minLength: 1maxLength: 63
variants_enabledBoolsk verdiValgfritt

Om produktet bruker varianter.

Standard: false

Ytterligere felt: Nei

Hent — Produkter — Svar

ProductDetailData · Felter, typer og begrensninger for data som API-et mottar eller returnerer.
availabilityAvailabilityData Obligatorisk

Tilgjengelighetsinformasjon for valgt kontekst.

Eksempel: {"available_from":null,"available_until":null,"is_available":true}
brand_idStreng nullObligatorisk

Merkeidentifikator.

Eksempel: null
conditionStrengObligatorisk

Produktets tilstand.

Begrensninger
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Eksempel: "new"
created_atStrengObligatorisk

Opprettelsestidspunkt.

format: "date-time"
Eksempel: "2026-01-01T12:00:00Z"
descriptionStreng nullObligatorisk

Beskrivelse på valgt språk.

Eksempel: "example"
featuresArray <FeatureSelectionData > Obligatorisk

Produktegenskaper.

Eksempel: [{"feature_id":"example","feature_name":"example","value":"example","value_id":"example"}]
idStrengObligatorisk

Ressursidentifikator; behold den slik den returneres. (ProductDetailData).

Eksempel: "example"
identifiersObjektYtterligere felt: StrengObligatorisk

Produktidentifikasjonskoder.

Eksempel: {}
mediaArray <ProductMediaData > Obligatorisk

Informasjon om tilknyttede medier.

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

Søkemotorbeskrivelse på valgt språk.

Eksempel: "example"
meta_keywordsArray <Streng> nullObligatorisk

Søkemotornøkkelord på valgt språk.

Eksempel: ["example"]
meta_titleStreng nullObligatorisk

Søkemotortittel på valgt språk.

Eksempel: "example"
nameStreng nullObligatorisk

Ressursens navn i den relevante konteksten.

Eksempel: "Example"
numberStrengObligatorisk

Ordre- eller saksnummer beregnet på mennesker.

Eksempel: "example"
pricePriceData nullObligatorisk

Prisinformasjon i valgt kontekst.

Eksempel: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
price_versionHeltallObligatorisk

Gjeldende prisversjon for samtidighetskontroll.

Eksempel: 1
primary_category_idStreng nullObligatorisk

Identifikator for primærkategori.

Eksempel: "example"
primary_media_idStreng nullObligatorisk

Identifikator for primærmediet.

Eksempel: "example"
publishedBoolsk verdiObligatorisk

Om ressursen er publisert.

Eksempel: false
skuStrengObligatorisk

SKU-varekode.

Eksempel: "example"
slugStreng nullObligatorisk

URL-stisegment på valgt språk.

Eksempel: "example"
tax_category_idStrengObligatorisk

Identifikator for avgiftskategori.

Eksempel: "example"
updated_atStrengObligatorisk

Tidspunkt for siste oppdatering.

format: "date-time"
Eksempel: "2026-01-01T12:00:00Z"
variants_enabledBoolsk verdiObligatorisk

Om produktet bruker varianter.

Eksempel: false
versionHeltallObligatorisk

Ressursversjon brukt til samtidighetskontroll.

Eksempel: 1

Ytterligere felt: Nei

Produktidentifikasjonskoder

ProductIdentifiers · Skjema · Dataskjemaer: Produkter
eanStreng nullValgfritt

Produktets EAN-identifikator.

Streng:minLength: 1maxLength: 100
isbnStreng nullValgfritt

ISBN-identifikator.

Streng:minLength: 1maxLength: 100
mpnStreng nullValgfritt

Produsentens delenummer.

Streng:minLength: 1maxLength: 100
upcStreng nullValgfritt

Produktets UPC-identifikator.

Streng:minLength: 1maxLength: 100

Ytterligere felt: Nei

Informasjon om tilknyttede medier

ProductMediaData · Skjema · Dataskjemaer: Produkter
alt_textStreng nullObligatorisk

Alternativ tekst for et bilde.

Eksempel: "example"
idStrengObligatorisk

Ressursidentifikator; behold den slik den returneres. (ProductMediaData).

Eksempel: "example"
is_primaryBoolsk verdiObligatorisk

Om dette er det primære elementet.

Eksempel: true
kindStrengObligatorisk

Variant av datastrukturen beskrevet av de tillatte verdiene.

Begrensninger
enum
["image", "video", "model_3d"]
Eksempel: "image"
mime_typeStrengObligatorisk

Mediets innholdstype.

Eksempel: "image/jpeg"
positionHeltallObligatorisk

Plassering i den sorterte samlingen.

Eksempel: 1
urlStreng nullObligatorisk

Ressursens URL.

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

Ytterligere felt: Nei

Priskonfigurasjon og versjonene for samtidighetskontroll

ProductPrice · Skjema · Dataskjemaer: Produkter
amountStreng nullObligatorisk

Desimalbeløp kodet som en JSON-streng; null bare der det er tillatt.

Streng:maxLength: 19
Begrensninger · Streng 1
pattern
"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
Eksempel: "0.00"
currencyStrengObligatorisk

Valutakode for beløpet.

Begrensninger
pattern
"^[A-Z]{3}$"
Eksempel: "PLN"
expected_price_list_versionHeltallObligatorisk

Tidligere lest prislisteversjon som kreves for denne skriveoperasjonen.

minimum: 1maximum: 9223372036854775807
Eksempel: 1
expected_versionHeltallObligatorisk

Versjon lest før skriveoperasjonen; et avvik avviser oppdateringen.

minimum: 0maximum: 9223372036854775807
Eksempel: 0
kindStrengObligatorisk

Variant av datastrukturen beskrevet av de tillatte verdiene.

Begrensninger
enum
["base", "market_fixed"]
Eksempel: "base"
price_list_idStrengObligatorisk

Prislisteidentifikator.

minLength: 1maxLength: 63
Eksempel: "example"
tax_includedBoolsk verdiObligatorisk

Om innsendt pris inkluderer avgifter.

Eksempel: true

Ytterligere felt: Nei

Vis liste — Produkter — Svar

ProductSummaryData · Felter, typer og begrensninger for data som API-et mottar eller returnerer.
availabilityAvailabilityData Obligatorisk

Tilgjengelighetsinformasjon for valgt kontekst.

Eksempel: {"available_from":null,"available_until":null,"is_available":true}
brand_idStreng nullObligatorisk

Merkeidentifikator.

Eksempel: null
conditionStrengObligatorisk

Produktets tilstand.

Begrensninger
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Eksempel: "new"
created_atStrengObligatorisk

Opprettelsestidspunkt.

format: "date-time"
Eksempel: "2026-01-01T12:00:00Z"
idStrengObligatorisk

Ressursidentifikator; behold den slik den returneres. (ProductSummaryData).

Eksempel: "example"
nameStreng nullObligatorisk

Ressursens navn i den relevante konteksten.

Eksempel: "Example"
numberStrengObligatorisk

Ordre- eller saksnummer beregnet på mennesker.

Eksempel: "example"
pricePriceData nullObligatorisk

Prisinformasjon i valgt kontekst.

Eksempel: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
price_versionHeltallObligatorisk

Gjeldende prisversjon for samtidighetskontroll.

Eksempel: 1
primary_category_idStreng nullObligatorisk

Identifikator for primærkategori.

Eksempel: "example"
primary_media_idStreng nullObligatorisk

Identifikator for primærmediet.

Eksempel: "example"
publishedBoolsk verdiObligatorisk

Om ressursen er publisert.

Eksempel: false
skuStrengObligatorisk

SKU-varekode.

Eksempel: "example"
slugStreng nullObligatorisk

URL-stisegment på valgt språk.

Eksempel: "example"
tax_category_idStrengObligatorisk

Identifikator for avgiftskategori.

Eksempel: "example"
updated_atStrengObligatorisk

Tidspunkt for siste oppdatering.

format: "date-time"
Eksempel: "2026-01-01T12:00:00Z"
variants_enabledBoolsk verdiObligatorisk

Om produktet bruker varianter.

Eksempel: false
versionHeltallObligatorisk

Ressursversjon brukt til samtidighetskontroll.

Eksempel: 1

Ytterligere felt: Nei

Oppdater — Produkter — Forespørselsinnhold

ProductUpdate · Felter, typer og begrensninger for data som API-et mottar eller returnerer.
brand_idStreng nullValgfritt

Merkeidentifikator.

Streng:minLength: 1maxLength: 63
conditionStrengValgfritt

Produktets tilstand.

Begrensninger
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
descriptionStreng nullValgfritt

Beskrivelse på valgt språk.

Streng:maxLength: 100000
Eksempel: null
expected_variant_price_versionsObjektYtterligere felt: Heltall
minimum: 0maximum: 9223372036854775807
Valgfritt

Tidligere leste prisversjoner med variantidentifikator som nøkkel.

maxProperties: 250
Begrensninger
propertyNames
{"maxLength": 63, "minLength": 1}
expected_versionHeltallObligatorisk

Versjon lest før skriveoperasjonen; et avvik avviser oppdateringen.

minimum: 1maximum: 9223372036854775807
Eksempel: 1
feature_value_idsArray <Streng> Valgfritt

Identifikatorer for valgte egenskapsverdier.

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

Produktidentifikasjonskoder.

market_idsArray <Streng> Valgfritt

Identifikatorer for valgte markeder.

maxItems: 1000
Array:minLength: 1maxLength: 63
media_idsArray <Streng> Valgfritt

Identifikatorer for medier som allerede finnes.

maxItems: 20
Array:minLength: 1maxLength: 63
meta_descriptionStreng nullValgfritt

Søkemotorbeskrivelse på valgt språk.

Streng:maxLength: 160
meta_keywordsArray <Streng> nullValgfritt

Søkemotornøkkelord på valgt språk.

Array:maxItems: 20
Array / Array:maxLength: 50
meta_titleStreng nullValgfritt

Søkemotortittel på valgt språk.

Streng:maxLength: 70
nameStreng nullValgfritt

Ressursens navn i den relevante konteksten.

Streng:maxLength: 300
Eksempel: null
pricingProductPrice Valgfritt

Priskonfigurasjon og versjonene for samtidighetskontroll.

Eksempel: {"amount":"0.00","currency":"PLN","expected_price_list_version":1,"expected_version":0,"kind":"base","price_list_id":"example","tax_included":true}
primary_category_idStreng nullValgfritt

Identifikator for primærkategori.

Streng:minLength: 1maxLength: 63
publishedBoolsk verdiValgfritt

Om ressursen er publisert.

skuStrengValgfritt

SKU-varekode.

minLength: 1maxLength: 100
Begrensninger
pattern
"^\\S+$"
Eksempel: "example"
slugStreng nullValgfritt

URL-stisegment på valgt språk.

Streng:maxLength: 160
tax_category_idStreng nullValgfritt

Identifikator for avgiftskategori.

Streng:minLength: 1maxLength: 63
variant_value_idsArray <Streng> Valgfritt

Identifikatorer for valgte variantverdier.

maxItems: 250
Array:minLength: 1maxLength: 63
variants_enabledBoolsk verdiValgfritt

Om produktet bruker varianter.

Ytterligere felt: Nei