Gå til indhold
ShopentlyLearn
Dansk

Dataskemaer: Produkter

Dataskemaer: Produkter. Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

Dataskemaer

Vis liste — Produkter — Svar

ApiResponse_list_ProductSummaryData__ · Felter, typer og begrænsninger for data, som API'et modtager 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"}

Yderligere felter: Nej

Hent — Produkter — Svar

ApiResponse_ProductDetailData_ · Felter, typer og begrænsninger for data, som API'et modtager 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"}

Yderligere felter: Nej

Tilgængelighedsoplysninger for den valgte kontekst

AvailabilityData · Skema · Dataskemaer: Produkter
available_fromStreng nullObligatorisk

Begyndelsen af tilgængelighedsperioden.

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

Slutningen af tilgængelighedsperioden.

Streng:format: "date-time"
Eksempel: null
is_availableBoolesk værdiObligatorisk

Om varen er tilgængelig i denne kontekst.

Eksempel: true

Yderligere felter: Nej

Prisoplysninger i den valgte kontekst

PriceData · Skema · Dataskemaer: Produkter
amountStrengObligatorisk

Decimalbeløb kodet som en JSON-streng; null kun hvor tilladt.

Eksempel: "0.00"
currencyStrengObligatorisk

Valutakode for beløbet.

Begrænsninger
pattern
"^[A-Z]{3}$"
Eksempel: "PLN"
minor_unitsHeltalObligatorisk

Antal decimaler, som valutaen bruger.

minimum: 0maximum: 4
Eksempel: 2
tax_includedBoolesk værdiObligatorisk

Om den indsendte pris inkluderer afgifter.

Eksempel: true

Yderligere felter: Nej

Prislisteoplysninger

PriceListData · Skema · Dataskemaer: Produkter
currencyStrengObligatorisk

Valutakode for beløbet.

idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret. (PriceListData).

tax_includedBoolesk værdiObligatorisk

Om den indsendte pris inkluderer afgifter.

versionHeltalObligatorisk

Ressourceversion anvendt til samtidighedskontrol.

Yderligere felter: Nej

Opret — Produkter — Forespørgselsindhold

ProductCreate · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
brand_idStreng nullValgfrit

Mærkeidentifikator.

Streng:minLength: 1maxLength: 63
conditionStrengValgfrit

Produktets stand.

Begrænsninger
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Standard: "new"
descriptionStreng nullValgfrit

Beskrivelse på det valgte sprog.

Streng:maxLength: 100000
feature_value_idsArray <Streng> Valgfrit

Identifikatorer for valgte egenskabsværdier.

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

Produktidentifikationskoder.

market_idsArray <Streng> Valgfrit

Identifikatorer for valgte markeder.

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

Identifikatorer for allerede eksisterende medier.

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

Beskrivelse til søgemaskiner på det valgte sprog.

Streng:maxLength: 160
meta_keywordsArray <Streng> nullValgfrit

Nøgleord til søgemaskiner på det valgte sprog.

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

Titel til søgemaskiner på det valgte sprog.

Streng:maxLength: 70
nameStrengObligatorisk

Ressourcens navn i den relevante kontekst.

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

Priskonfiguration og dens versioner til samtidighedskontrol.

primary_category_idStreng nullValgfrit

Identifikator for primær kategori.

Streng:minLength: 1maxLength: 63
publishedBoolesk værdiValgfrit

Om ressourcen er offentliggjort.

Standard: false
skuStrengObligatorisk

SKU-varekode.

minLength: 1maxLength: 100
Begrænsninger
pattern
"^\\S+$"
Eksempel: "example"
slugStreng nullValgfrit

URL-stisegment på det valgte sprog.

Streng:maxLength: 160
tax_category_idStreng nullValgfrit

Identifikator for afgiftskategori.

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

Identifikatorer for valgte variantværdier.

maxItems: 250
Array:minLength: 1maxLength: 63
variants_enabledBoolesk værdiValgfrit

Om produktet bruger varianter.

Standard: false

Yderligere felter: Nej

Hent — Produkter — Svar

ProductDetailData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
availabilityAvailabilityData Obligatorisk

Tilgængelighedsoplysninger for den valgte kontekst.

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

Mærkeidentifikator.

Eksempel: null
conditionStrengObligatorisk

Produktets stand.

Begrænsninger
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Eksempel: "new"
created_atStrengObligatorisk

Oprettelsestidspunkt.

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

Beskrivelse på det valgte sprog.

Eksempel: "example"
featuresArray <FeatureSelectionData > Obligatorisk

Produktegenskaber.

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

Ressourceidentifikator; bevar den som returneret. (ProductDetailData).

Eksempel: "example"
identifiersObjektYderligere felter: StrengObligatorisk

Produktidentifikationskoder.

Eksempel: {}
mediaArray <ProductMediaData > Obligatorisk

Oplysninger 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

Beskrivelse til søgemaskiner på det valgte sprog.

Eksempel: "example"
meta_keywordsArray <Streng> nullObligatorisk

Nøgleord til søgemaskiner på det valgte sprog.

Eksempel: ["example"]
meta_titleStreng nullObligatorisk

Titel til søgemaskiner på det valgte sprog.

Eksempel: "example"
nameStreng nullObligatorisk

Ressourcens navn i den relevante kontekst.

Eksempel: "Example"
numberStrengObligatorisk

Ordre- eller sagsnummer beregnet til mennesker.

Eksempel: "example"
pricePriceData nullObligatorisk

Prisoplysninger i den valgte kontekst.

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

Aktuel prisversion til samtidighedskontrol.

Eksempel: 1
primary_category_idStreng nullObligatorisk

Identifikator for primær kategori.

Eksempel: "example"
primary_media_idStreng nullObligatorisk

Identifikator for primært medie.

Eksempel: "example"
publishedBoolesk værdiObligatorisk

Om ressourcen er offentliggjort.

Eksempel: false
skuStrengObligatorisk

SKU-varekode.

Eksempel: "example"
slugStreng nullObligatorisk

URL-stisegment på det valgte sprog.

Eksempel: "example"
tax_category_idStrengObligatorisk

Identifikator for afgiftskategori.

Eksempel: "example"
updated_atStrengObligatorisk

Tidspunkt for seneste opdatering.

format: "date-time"
Eksempel: "2026-01-01T12:00:00Z"
variants_enabledBoolesk værdiObligatorisk

Om produktet bruger varianter.

Eksempel: false
versionHeltalObligatorisk

Ressourceversion anvendt til samtidighedskontrol.

Eksempel: 1

Yderligere felter: Nej

Produktidentifikationskoder

ProductIdentifiers · Skema · Dataskemaer: Produkter
eanStreng nullValgfrit

Produktets EAN-identifikator.

Streng:minLength: 1maxLength: 100
isbnStreng nullValgfrit

ISBN-identifikator.

Streng:minLength: 1maxLength: 100
mpnStreng nullValgfrit

Producentens varenummer.

Streng:minLength: 1maxLength: 100
upcStreng nullValgfrit

Produktets UPC-identifikator.

Streng:minLength: 1maxLength: 100

Yderligere felter: Nej

Oplysninger om tilknyttede medier

ProductMediaData · Skema · Dataskemaer: Produkter
alt_textStreng nullObligatorisk

Alternativ tekst til et billede.

Eksempel: "example"
idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret. (ProductMediaData).

Eksempel: "example"
is_primaryBoolesk værdiObligatorisk

Om dette er det primære element.

Eksempel: true
kindStrengObligatorisk

Variant af datastrukturen beskrevet ved de tilladte værdier.

Begrænsninger
enum
["image", "video", "model_3d"]
Eksempel: "image"
mime_typeStrengObligatorisk

Mediets indholdstype.

Eksempel: "image/jpeg"
positionHeltalObligatorisk

Placering i den sorterede samling.

Eksempel: 1
urlStreng nullObligatorisk

Ressourcens URL.

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

Yderligere felter: Nej

Priskonfiguration og dens versioner til samtidighedskontrol

ProductPrice · Skema · Dataskemaer: Produkter
amountStreng nullObligatorisk

Decimalbeløb kodet som en JSON-streng; null kun hvor tilladt.

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

Valutakode for beløbet.

Begrænsninger
pattern
"^[A-Z]{3}$"
Eksempel: "PLN"
expected_price_list_versionHeltalObligatorisk

Tidligere læst prislisteversion, som kræves til denne skriveoperation.

minimum: 1maximum: 9223372036854775807
Eksempel: 1
expected_versionHeltalObligatorisk

Version læst før skriveoperationen; uoverensstemmelse afviser opdateringen.

minimum: 0maximum: 9223372036854775807
Eksempel: 0
kindStrengObligatorisk

Variant af datastrukturen beskrevet ved de tilladte værdier.

Begrænsninger
enum
["base", "market_fixed"]
Eksempel: "base"
price_list_idStrengObligatorisk

Prislisteidentifikator.

minLength: 1maxLength: 63
Eksempel: "example"
tax_includedBoolesk værdiObligatorisk

Om den indsendte pris inkluderer afgifter.

Eksempel: true

Yderligere felter: Nej

Vis liste — Produkter — Svar

ProductSummaryData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
availabilityAvailabilityData Obligatorisk

Tilgængelighedsoplysninger for den valgte kontekst.

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

Mærkeidentifikator.

Eksempel: null
conditionStrengObligatorisk

Produktets stand.

Begrænsninger
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Eksempel: "new"
created_atStrengObligatorisk

Oprettelsestidspunkt.

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

Ressourceidentifikator; bevar den som returneret. (ProductSummaryData).

Eksempel: "example"
nameStreng nullObligatorisk

Ressourcens navn i den relevante kontekst.

Eksempel: "Example"
numberStrengObligatorisk

Ordre- eller sagsnummer beregnet til mennesker.

Eksempel: "example"
pricePriceData nullObligatorisk

Prisoplysninger i den valgte kontekst.

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

Aktuel prisversion til samtidighedskontrol.

Eksempel: 1
primary_category_idStreng nullObligatorisk

Identifikator for primær kategori.

Eksempel: "example"
primary_media_idStreng nullObligatorisk

Identifikator for primært medie.

Eksempel: "example"
publishedBoolesk værdiObligatorisk

Om ressourcen er offentliggjort.

Eksempel: false
skuStrengObligatorisk

SKU-varekode.

Eksempel: "example"
slugStreng nullObligatorisk

URL-stisegment på det valgte sprog.

Eksempel: "example"
tax_category_idStrengObligatorisk

Identifikator for afgiftskategori.

Eksempel: "example"
updated_atStrengObligatorisk

Tidspunkt for seneste opdatering.

format: "date-time"
Eksempel: "2026-01-01T12:00:00Z"
variants_enabledBoolesk værdiObligatorisk

Om produktet bruger varianter.

Eksempel: false
versionHeltalObligatorisk

Ressourceversion anvendt til samtidighedskontrol.

Eksempel: 1

Yderligere felter: Nej

Opdater — Produkter — Forespørgselsindhold

ProductUpdate · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
brand_idStreng nullValgfrit

Mærkeidentifikator.

Streng:minLength: 1maxLength: 63
conditionStrengValgfrit

Produktets stand.

Begrænsninger
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
descriptionStreng nullValgfrit

Beskrivelse på det valgte sprog.

Streng:maxLength: 100000
Eksempel: null
expected_variant_price_versionsObjektYderligere felter: Heltal
minimum: 0maximum: 9223372036854775807
Valgfrit

Tidligere læste prisversioner med variantidentifikator som nøgle.

maxProperties: 250
Begrænsninger
propertyNames
{"maxLength": 63, "minLength": 1}
expected_versionHeltalObligatorisk

Version læst før skriveoperationen; uoverensstemmelse afviser opdateringen.

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

Identifikatorer for valgte egenskabsværdier.

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

Produktidentifikationskoder.

market_idsArray <Streng> Valgfrit

Identifikatorer for valgte markeder.

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

Identifikatorer for allerede eksisterende medier.

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

Beskrivelse til søgemaskiner på det valgte sprog.

Streng:maxLength: 160
meta_keywordsArray <Streng> nullValgfrit

Nøgleord til søgemaskiner på det valgte sprog.

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

Titel til søgemaskiner på det valgte sprog.

Streng:maxLength: 70
nameStreng nullValgfrit

Ressourcens navn i den relevante kontekst.

Streng:maxLength: 300
Eksempel: null
pricingProductPrice Valgfrit

Priskonfiguration og dens versioner til samtidighedskontrol.

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 nullValgfrit

Identifikator for primær kategori.

Streng:minLength: 1maxLength: 63
publishedBoolesk værdiValgfrit

Om ressourcen er offentliggjort.

skuStrengValgfrit

SKU-varekode.

minLength: 1maxLength: 100
Begrænsninger
pattern
"^\\S+$"
Eksempel: "example"
slugStreng nullValgfrit

URL-stisegment på det valgte sprog.

Streng:maxLength: 160
tax_category_idStreng nullValgfrit

Identifikator for afgiftskategori.

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

Identifikatorer for valgte variantværdier.

maxItems: 250
Array:minLength: 1maxLength: 63
variants_enabledBoolesk værdiValgfrit

Om produktet bruger varianter.

Yderligere felter: Nej