Hoppa till innehållet
ShopentlyLearn

Datascheman: Produkter

Datascheman: Produkter. Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

Datascheman

Lista — Produkter — Svar

ApiResponse_list_ProductSummaryData__ · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
dataArray <ProductSummaryData > Obligatoriskt

Exempel på svar · ApiResponse_list_ProductSummaryData__.

Exempel: [{"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 Obligatoriskt

Metadata för svaret.

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

Ytterligare fält: Nej

Hämta — Produkter — Svar

ApiResponse_ProductDetailData_ · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
dataProductDetailData Obligatoriskt

Exempel på svar · ProductDetailData.

Exempel: {"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 Obligatoriskt

Metadata för svaret.

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

Ytterligare fält: Nej

Tillgänglighetsinformation för vald kontext

AvailabilityData · Schema · Datascheman: Produkter
available_fromSträng nullObligatoriskt

Tillgänglighetens start.

Sträng:format: "date-time"
Exempel: null
available_untilSträng nullObligatoriskt

Tillgänglighetens slut.

Sträng:format: "date-time"
Exempel: null
is_availableBooleskt värdeObligatoriskt

Anger om artikeln är tillgänglig i denna kontext.

Exempel: true

Ytterligare fält: Nej

Prisinformation i vald kontext

PriceData · Schema · Datascheman: Produkter
amountSträngObligatoriskt

Decimalbelopp kodat som JSON-sträng; null endast där det tillåts.

Exempel: "0.00"
currencySträngObligatoriskt

Valutakod för beloppet.

Begränsningar
pattern
"^[A-Z]{3}$"
Exempel: "PLN"
minor_unitsHeltalObligatoriskt

Antal decimaler som används för valutan.

minimum: 0maximum: 4
Exempel: 2
tax_includedBooleskt värdeObligatoriskt

Anger om det skickade priset inkluderar skatt.

Exempel: true

Ytterligare fält: Nej

Information om prislistan

PriceListData · Schema · Datascheman: Produkter
currencySträngObligatoriskt

Valutakod för beloppet.

idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras. (PriceListData).

tax_includedBooleskt värdeObligatoriskt

Anger om det skickade priset inkluderar skatt.

versionHeltalObligatoriskt

Resursversion för samtidighetskontroll.

Ytterligare fält: Nej

Skapa — Produkter — Begärans innehåll

ProductCreate · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
brand_idSträng nullValfritt

Varumärkets identifierare.

Sträng:minLength: 1maxLength: 63
conditionSträngValfritt

Produktens skick.

Begränsningar
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Standardvärde: "new"
descriptionSträng nullValfritt

Beskrivning på valt språk.

Sträng:maxLength: 100000
feature_value_idsArray <Sträng> Valfritt

Identifierare för valda egenskapsvärden.

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

Produktens identifieringskoder.

market_idsArray <Sträng> Valfritt

Identifierare för valda marknader.

maxItems: 1000
Array:minLength: 1maxLength: 63
media_idsArray <Sträng> Valfritt

Identifierare för redan befintliga medieresurser.

maxItems: 20
Array:minLength: 1maxLength: 63
meta_descriptionSträng nullValfritt

Sökmotorbeskrivning på valt språk.

Sträng:maxLength: 160
meta_keywordsArray <Sträng> nullValfritt

Sökord för sökmotorer på valt språk.

Array:maxItems: 20
Array / Array:maxLength: 50
meta_titleSträng nullValfritt

Sökmotortitel på valt språk.

Sträng:maxLength: 70
nameSträngObligatoriskt

Resursens namn i aktuell kontext.

minLength: 1maxLength: 300
Exempel: "Example"
pricingProductPrice Valfritt

Priskonfiguration och dess versioner för samtidighetskontroll.

primary_category_idSträng nullValfritt

Huvudkategorins identifierare.

Sträng:minLength: 1maxLength: 63
publishedBooleskt värdeValfritt

Anger om resursen är publicerad.

Standardvärde: false
skuSträngObligatoriskt

Artikelns SKU-kod.

minLength: 1maxLength: 100
Begränsningar
pattern
"^\\S+$"
Exempel: "example"
slugSträng nullValfritt

URL-segment på valt språk.

Sträng:maxLength: 160
tax_category_idSträng nullValfritt

Skattekategorins identifierare.

Sträng:minLength: 1maxLength: 63
variant_value_idsArray <Sträng> Valfritt

Identifierare för valda variantvärden.

maxItems: 250
Array:minLength: 1maxLength: 63
variants_enabledBooleskt värdeValfritt

Anger om produkten använder varianter.

Standardvärde: false

Ytterligare fält: Nej

Hämta — Produkter — Svar

ProductDetailData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
availabilityAvailabilityData Obligatoriskt

Tillgänglighetsinformation för vald kontext.

Exempel: {"available_from":null,"available_until":null,"is_available":true}
brand_idSträng nullObligatoriskt

Varumärkets identifierare.

Exempel: null
conditionSträngObligatoriskt

Produktens skick.

Begränsningar
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Exempel: "new"
created_atSträngObligatoriskt

Tidpunkt för skapande.

format: "date-time"
Exempel: "2026-01-01T12:00:00Z"
descriptionSträng nullObligatoriskt

Beskrivning på valt språk.

Exempel: "example"
featuresArray <FeatureSelectionData > Obligatoriskt

Produktens egenskaper.

Exempel: [{"feature_id":"example","feature_name":"example","value":"example","value_id":"example"}]
idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras. (ProductDetailData).

Exempel: "example"
identifiersObjektYtterligare fält: SträngObligatoriskt

Produktens identifieringskoder.

Exempel: {}
mediaArray <ProductMediaData > Obligatoriskt

Information om bifogade medier.

Exempel: [{"alt_text":"example","id":"example","is_primary":true,"kind":"image","mime_type":"image/jpeg","position":1,"url":"https://example.invalid/product.jpg"}]
meta_descriptionSträng nullObligatoriskt

Sökmotorbeskrivning på valt språk.

Exempel: "example"
meta_keywordsArray <Sträng> nullObligatoriskt

Sökord för sökmotorer på valt språk.

Exempel: ["example"]
meta_titleSträng nullObligatoriskt

Sökmotortitel på valt språk.

Exempel: "example"
nameSträng nullObligatoriskt

Resursens namn i aktuell kontext.

Exempel: "Example"
numberSträngObligatoriskt

Beställnings- eller ärendenummer som visas för användaren.

Exempel: "example"
pricePriceData nullObligatoriskt

Prisinformation i vald kontext.

Exempel: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
price_versionHeltalObligatoriskt

Aktuell prisversion för samtidighetskontroll.

Exempel: 1
primary_category_idSträng nullObligatoriskt

Huvudkategorins identifierare.

Exempel: "example"
primary_media_idSträng nullObligatoriskt

Identifierare för primär medieresurs.

Exempel: "example"
publishedBooleskt värdeObligatoriskt

Anger om resursen är publicerad.

Exempel: false
skuSträngObligatoriskt

Artikelns SKU-kod.

Exempel: "example"
slugSträng nullObligatoriskt

URL-segment på valt språk.

Exempel: "example"
tax_category_idSträngObligatoriskt

Skattekategorins identifierare.

Exempel: "example"
updated_atSträngObligatoriskt

Tidpunkt för senaste uppdatering.

format: "date-time"
Exempel: "2026-01-01T12:00:00Z"
variants_enabledBooleskt värdeObligatoriskt

Anger om produkten använder varianter.

Exempel: false
versionHeltalObligatoriskt

Resursversion för samtidighetskontroll.

Exempel: 1

Ytterligare fält: Nej

Produktens identifieringskoder

ProductIdentifiers · Schema · Datascheman: Produkter
eanSträng nullValfritt

Produktens EAN-identifierare.

Sträng:minLength: 1maxLength: 100
isbnSträng nullValfritt

ISBN-identifierare.

Sträng:minLength: 1maxLength: 100
mpnSträng nullValfritt

Tillverkarens artikelnummer.

Sträng:minLength: 1maxLength: 100
upcSträng nullValfritt

Produktens UPC-identifierare.

Sträng:minLength: 1maxLength: 100

Ytterligare fält: Nej

Information om bifogade medier

ProductMediaData · Schema · Datascheman: Produkter
alt_textSträng nullObligatoriskt

Alternativtext för en bild.

Exempel: "example"
idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras. (ProductMediaData).

Exempel: "example"
is_primaryBooleskt värdeObligatoriskt

Anger om detta är huvudposten.

Exempel: true
kindSträngObligatoriskt

Variant av datastrukturen, enligt dess tillåtna värden.

Begränsningar
enum
["image", "video", "model_3d"]
Exempel: "image"
mime_typeSträngObligatoriskt

Medieinnehållets typ.

Exempel: "image/jpeg"
positionHeltalObligatoriskt

Position i den ordnade samlingen.

Exempel: 1
urlSträng nullObligatoriskt

Resursens URL.

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

Ytterligare fält: Nej

Priskonfiguration och dess versioner för samtidighetskontroll

ProductPrice · Schema · Datascheman: Produkter
amountSträng nullObligatoriskt

Decimalbelopp kodat som JSON-sträng; null endast där det tillåts.

Sträng:maxLength: 19
Begränsningar · Sträng 1
pattern
"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
Exempel: "0.00"
currencySträngObligatoriskt

Valutakod för beloppet.

Begränsningar
pattern
"^[A-Z]{3}$"
Exempel: "PLN"
expected_price_list_versionHeltalObligatoriskt

Tidigare läst prislistversion som krävs för skrivningen.

minimum: 1maximum: 9223372036854775807
Exempel: 1
expected_versionHeltalObligatoriskt

Version läst före skrivningen; avvikelse gör att ändringen avvisas.

minimum: 0maximum: 9223372036854775807
Exempel: 0
kindSträngObligatoriskt

Variant av datastrukturen, enligt dess tillåtna värden.

Begränsningar
enum
["base", "market_fixed"]
Exempel: "base"
price_list_idSträngObligatoriskt

Prislistans identifierare.

minLength: 1maxLength: 63
Exempel: "example"
tax_includedBooleskt värdeObligatoriskt

Anger om det skickade priset inkluderar skatt.

Exempel: true

Ytterligare fält: Nej

Lista — Produkter — Svar

ProductSummaryData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
availabilityAvailabilityData Obligatoriskt

Tillgänglighetsinformation för vald kontext.

Exempel: {"available_from":null,"available_until":null,"is_available":true}
brand_idSträng nullObligatoriskt

Varumärkets identifierare.

Exempel: null
conditionSträngObligatoriskt

Produktens skick.

Begränsningar
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Exempel: "new"
created_atSträngObligatoriskt

Tidpunkt för skapande.

format: "date-time"
Exempel: "2026-01-01T12:00:00Z"
idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras. (ProductSummaryData).

Exempel: "example"
nameSträng nullObligatoriskt

Resursens namn i aktuell kontext.

Exempel: "Example"
numberSträngObligatoriskt

Beställnings- eller ärendenummer som visas för användaren.

Exempel: "example"
pricePriceData nullObligatoriskt

Prisinformation i vald kontext.

Exempel: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
price_versionHeltalObligatoriskt

Aktuell prisversion för samtidighetskontroll.

Exempel: 1
primary_category_idSträng nullObligatoriskt

Huvudkategorins identifierare.

Exempel: "example"
primary_media_idSträng nullObligatoriskt

Identifierare för primär medieresurs.

Exempel: "example"
publishedBooleskt värdeObligatoriskt

Anger om resursen är publicerad.

Exempel: false
skuSträngObligatoriskt

Artikelns SKU-kod.

Exempel: "example"
slugSträng nullObligatoriskt

URL-segment på valt språk.

Exempel: "example"
tax_category_idSträngObligatoriskt

Skattekategorins identifierare.

Exempel: "example"
updated_atSträngObligatoriskt

Tidpunkt för senaste uppdatering.

format: "date-time"
Exempel: "2026-01-01T12:00:00Z"
variants_enabledBooleskt värdeObligatoriskt

Anger om produkten använder varianter.

Exempel: false
versionHeltalObligatoriskt

Resursversion för samtidighetskontroll.

Exempel: 1

Ytterligare fält: Nej

Uppdatera — Produkter — Begärans innehåll

ProductUpdate · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
brand_idSträng nullValfritt

Varumärkets identifierare.

Sträng:minLength: 1maxLength: 63
conditionSträngValfritt

Produktens skick.

Begränsningar
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
descriptionSträng nullValfritt

Beskrivning på valt språk.

Sträng:maxLength: 100000
Exempel: null
expected_variant_price_versionsObjektYtterligare fält: Heltal
minimum: 0maximum: 9223372036854775807
Valfritt

Tidigare lästa prisversioner, kopplade till variantidentifierare.

maxProperties: 250
Begränsningar
propertyNames
{"maxLength": 63, "minLength": 1}
expected_versionHeltalObligatoriskt

Version läst före skrivningen; avvikelse gör att ändringen avvisas.

minimum: 1maximum: 9223372036854775807
Exempel: 1
feature_value_idsArray <Sträng> Valfritt

Identifierare för valda egenskapsvärden.

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

Produktens identifieringskoder.

market_idsArray <Sträng> Valfritt

Identifierare för valda marknader.

maxItems: 1000
Array:minLength: 1maxLength: 63
media_idsArray <Sträng> Valfritt

Identifierare för redan befintliga medieresurser.

maxItems: 20
Array:minLength: 1maxLength: 63
meta_descriptionSträng nullValfritt

Sökmotorbeskrivning på valt språk.

Sträng:maxLength: 160
meta_keywordsArray <Sträng> nullValfritt

Sökord för sökmotorer på valt språk.

Array:maxItems: 20
Array / Array:maxLength: 50
meta_titleSträng nullValfritt

Sökmotortitel på valt språk.

Sträng:maxLength: 70
nameSträng nullValfritt

Resursens namn i aktuell kontext.

Sträng:maxLength: 300
Exempel: null
pricingProductPrice Valfritt

Priskonfiguration och dess versioner för samtidighetskontroll.

Exempel: {"amount":"0.00","currency":"PLN","expected_price_list_version":1,"expected_version":0,"kind":"base","price_list_id":"example","tax_included":true}
primary_category_idSträng nullValfritt

Huvudkategorins identifierare.

Sträng:minLength: 1maxLength: 63
publishedBooleskt värdeValfritt

Anger om resursen är publicerad.

skuSträngValfritt

Artikelns SKU-kod.

minLength: 1maxLength: 100
Begränsningar
pattern
"^\\S+$"
Exempel: "example"
slugSträng nullValfritt

URL-segment på valt språk.

Sträng:maxLength: 160
tax_category_idSträng nullValfritt

Skattekategorins identifierare.

Sträng:minLength: 1maxLength: 63
variant_value_idsArray <Sträng> Valfritt

Identifierare för valda variantvärden.

maxItems: 250
Array:minLength: 1maxLength: 63
variants_enabledBooleskt värdeValfritt

Anger om produkten använder varianter.

Ytterligare fält: Nej