Preskočiť na obsah
ShopentlyLearn

Dátové schémy: Produkty

Dátové schémy: Produkty. Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

Dátové schémy

Zobraziť zoznam — Produkty — Odpoveď

ApiResponse_list_ProductSummaryData__ · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
dataPole <ProductSummaryData > Povinné

Príklad odpovede · ApiResponse_list_ProductSummaryData__.

Príklad: [{"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 Povinné

Metaúdaje odpovede.

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

Ďalšie polia: Nie

Načítať — Produkty — Odpoveď

ApiResponse_ProductDetailData_ · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
dataProductDetailData Povinné

Príklad odpovede · ProductDetailData.

Príklad: {"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 Povinné

Metaúdaje odpovede.

Príklad: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Ďalšie polia: Nie

Informácie o dostupnosti vo vybranom kontexte

AvailabilityData · Schéma · Dátové schémy: Produkty
available_fromReťazec nullPovinné

Začiatok dostupnosti.

Reťazec:format: "date-time"
Príklad: null
available_untilReťazec nullPovinné

Koniec dostupnosti.

Reťazec:format: "date-time"
Príklad: null
is_availableLogická hodnotaPovinné

Či je položka v tomto kontexte dostupná.

Príklad: true

Ďalšie polia: Nie

Informácie o cene vo vybranom kontexte

PriceData · Schéma · Dátové schémy: Produkty
amountReťazecPovinné

Desatinná suma zapísaná ako reťazec JSON; null iba tam, kde je povolené.

Príklad: "0.00"
currencyReťazecPovinné

Kód meny sumy.

Obmedzenia
pattern
"^[A-Z]{3}$"
Príklad: "PLN"
minor_unitsCelé čísloPovinné

Počet desatinných miest používaných menou.

minimum: 0maximum: 4
Príklad: 2
tax_includedLogická hodnotaPovinné

Či zadaná cena zahŕňa daň.

Príklad: true

Ďalšie polia: Nie

Informácie o cenníku

PriceListData · Schéma · Dátové schémy: Produkty
currencyReťazecPovinné

Kód meny sumy.

idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený. (PriceListData).

tax_includedLogická hodnotaPovinné

Či zadaná cena zahŕňa daň.

versionCelé čísloPovinné

Verzia zdroja používaná na riadenie súbežných zmien.

Ďalšie polia: Nie

Vytvoriť — Produkty — Telo požiadavky

ProductCreate · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
brand_idReťazec nullVoliteľné

Identifikátor značky.

Reťazec:minLength: 1maxLength: 63
conditionReťazecVoliteľné

Stav produktu.

Obmedzenia
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Predvolená hodnota: "new"
descriptionReťazec nullVoliteľné

Opis vo vybranom jazyku.

Reťazec:maxLength: 100000
feature_value_idsPole <Reťazec> Voliteľné

Identifikátory vybraných hodnôt vlastností.

maxItems: 1000
Pole:minLength: 1maxLength: 63
identifiersProductIdentifiers nullVoliteľné

Identifikačné kódy produktu.

market_idsPole <Reťazec> Voliteľné

Identifikátory vybraných trhov.

maxItems: 1000
Pole:minLength: 1maxLength: 63
media_idsPole <Reťazec> Voliteľné

Identifikátory už existujúcich mediálnych súborov.

maxItems: 20
Pole:minLength: 1maxLength: 63
meta_descriptionReťazec nullVoliteľné

Opis pre vyhľadávače vo vybranom jazyku.

Reťazec:maxLength: 160
meta_keywordsPole <Reťazec> nullVoliteľné

Kľúčové slová pre vyhľadávače vo vybranom jazyku.

Pole:maxItems: 20
Pole / Pole:maxLength: 50
meta_titleReťazec nullVoliteľné

Titulok pre vyhľadávače vo vybranom jazyku.

Reťazec:maxLength: 70
nameReťazecPovinné

Názov zdroja v príslušnom kontexte.

minLength: 1maxLength: 300
Príklad: "Example"
pricingProductPrice Voliteľné

Nastavenie cien a ich verzie na riadenie súbežných zmien.

primary_category_idReťazec nullVoliteľné

Identifikátor hlavnej kategórie.

Reťazec:minLength: 1maxLength: 63
publishedLogická hodnotaVoliteľné

Či je zdroj zverejnený.

Predvolená hodnota: false
skuReťazecPovinné

Skladový kód položky.

minLength: 1maxLength: 100
Obmedzenia
pattern
"^\\S+$"
Príklad: "example"
slugReťazec nullVoliteľné

Úsek cesty URL vo vybranom jazyku.

Reťazec:maxLength: 160
tax_category_idReťazec nullVoliteľné

Identifikátor daňovej kategórie.

Reťazec:minLength: 1maxLength: 63
variant_value_idsPole <Reťazec> Voliteľné

Identifikátory vybraných hodnôt variantov.

maxItems: 250
Pole:minLength: 1maxLength: 63
variants_enabledLogická hodnotaVoliteľné

Či produkt používa varianty.

Predvolená hodnota: false

Ďalšie polia: Nie

Načítať — Produkty — Odpoveď

ProductDetailData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
availabilityAvailabilityData Povinné

Informácie o dostupnosti vo vybranom kontexte.

Príklad: {"available_from":null,"available_until":null,"is_available":true}
brand_idReťazec nullPovinné

Identifikátor značky.

Príklad: null
conditionReťazecPovinné

Stav produktu.

Obmedzenia
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Príklad: "new"
created_atReťazecPovinné

Čas vytvorenia.

format: "date-time"
Príklad: "2026-01-01T12:00:00Z"
descriptionReťazec nullPovinné

Opis vo vybranom jazyku.

Príklad: "example"
featuresPole <FeatureSelectionData > Povinné

Vlastnosti produktu.

Príklad: [{"feature_id":"example","feature_name":"example","value":"example","value_id":"example"}]
idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený. (ProductDetailData).

Príklad: "example"
identifiersObjektĎalšie polia: ReťazecPovinné

Identifikačné kódy produktu.

Príklad: {}
mediaPole <ProductMediaData > Povinné

Informácie o pripojených médiách.

Príklad: [{"alt_text":"example","id":"example","is_primary":true,"kind":"image","mime_type":"image/jpeg","position":1,"url":"https://example.invalid/product.jpg"}]
meta_descriptionReťazec nullPovinné

Opis pre vyhľadávače vo vybranom jazyku.

Príklad: "example"
meta_keywordsPole <Reťazec> nullPovinné

Kľúčové slová pre vyhľadávače vo vybranom jazyku.

Príklad: ["example"]
meta_titleReťazec nullPovinné

Titulok pre vyhľadávače vo vybranom jazyku.

Príklad: "example"
nameReťazec nullPovinné

Názov zdroja v príslušnom kontexte.

Príklad: "Example"
numberReťazecPovinné

Číslo objednávky alebo zákazníckej žiadosti určené pre používateľa.

Príklad: "example"
pricePriceData nullPovinné

Informácie o cene vo vybranom kontexte.

Príklad: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
price_versionCelé čísloPovinné

Aktuálna verzia ceny na riadenie súbežných zmien.

Príklad: 1
primary_category_idReťazec nullPovinné

Identifikátor hlavnej kategórie.

Príklad: "example"
primary_media_idReťazec nullPovinné

Identifikátor hlavného mediálneho súboru.

Príklad: "example"
publishedLogická hodnotaPovinné

Či je zdroj zverejnený.

Príklad: false
skuReťazecPovinné

Skladový kód položky.

Príklad: "example"
slugReťazec nullPovinné

Úsek cesty URL vo vybranom jazyku.

Príklad: "example"
tax_category_idReťazecPovinné

Identifikátor daňovej kategórie.

Príklad: "example"
updated_atReťazecPovinné

Čas poslednej aktualizácie.

format: "date-time"
Príklad: "2026-01-01T12:00:00Z"
variants_enabledLogická hodnotaPovinné

Či produkt používa varianty.

Príklad: false
versionCelé čísloPovinné

Verzia zdroja používaná na riadenie súbežných zmien.

Príklad: 1

Ďalšie polia: Nie

Identifikačné kódy produktu

ProductIdentifiers · Schéma · Dátové schémy: Produkty
eanReťazec nullVoliteľné

Identifikátor produktu EAN.

Reťazec:minLength: 1maxLength: 100
isbnReťazec nullVoliteľné

Identifikátor ISBN.

Reťazec:minLength: 1maxLength: 100
mpnReťazec nullVoliteľné

Katalógové číslo výrobcu.

Reťazec:minLength: 1maxLength: 100
upcReťazec nullVoliteľné

Identifikátor produktu UPC.

Reťazec:minLength: 1maxLength: 100

Ďalšie polia: Nie

Informácie o pripojených médiách

ProductMediaData · Schéma · Dátové schémy: Produkty
alt_textReťazec nullPovinné

Alternatívny text obrázka.

Príklad: "example"
idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený. (ProductMediaData).

Príklad: "example"
is_primaryLogická hodnotaPovinné

Či ide o hlavnú položku.

Príklad: true
kindReťazecPovinné

Variant dátovej štruktúry opísaný povolenými hodnotami.

Obmedzenia
enum
["image", "video", "model_3d"]
Príklad: "image"
mime_typeReťazecPovinné

Typ obsahu média.

Príklad: "image/jpeg"
positionCelé čísloPovinné

Pozícia v zoradenom zozname.

Príklad: 1
urlReťazec nullPovinné

URL zdroja.

Príklad: "https://example.invalid/product.jpg"

Ďalšie polia: Nie

Nastavenie cien a ich verzie na riadenie súbežných zmien

ProductPrice · Schéma · Dátové schémy: Produkty
amountReťazec nullPovinné

Desatinná suma zapísaná ako reťazec JSON; null iba tam, kde je povolené.

Reťazec:maxLength: 19
Obmedzenia · Reťazec 1
pattern
"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
Príklad: "0.00"
currencyReťazecPovinné

Kód meny sumy.

Obmedzenia
pattern
"^[A-Z]{3}$"
Príklad: "PLN"
expected_price_list_versionCelé čísloPovinné

Skôr načítaná verzia cenníka požadovaná pre tento zápis.

minimum: 1maximum: 9223372036854775807
Príklad: 1
expected_versionCelé čísloPovinné

Verzia načítaná pred zápisom; pri nezhode sa aktualizácia odmietne.

minimum: 0maximum: 9223372036854775807
Príklad: 0
kindReťazecPovinné

Variant dátovej štruktúry opísaný povolenými hodnotami.

Obmedzenia
enum
["base", "market_fixed"]
Príklad: "base"
price_list_idReťazecPovinné

Identifikátor cenníka.

minLength: 1maxLength: 63
Príklad: "example"
tax_includedLogická hodnotaPovinné

Či zadaná cena zahŕňa daň.

Príklad: true

Ďalšie polia: Nie

Zobraziť zoznam — Produkty — Odpoveď

ProductSummaryData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
availabilityAvailabilityData Povinné

Informácie o dostupnosti vo vybranom kontexte.

Príklad: {"available_from":null,"available_until":null,"is_available":true}
brand_idReťazec nullPovinné

Identifikátor značky.

Príklad: null
conditionReťazecPovinné

Stav produktu.

Obmedzenia
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Príklad: "new"
created_atReťazecPovinné

Čas vytvorenia.

format: "date-time"
Príklad: "2026-01-01T12:00:00Z"
idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený. (ProductSummaryData).

Príklad: "example"
nameReťazec nullPovinné

Názov zdroja v príslušnom kontexte.

Príklad: "Example"
numberReťazecPovinné

Číslo objednávky alebo zákazníckej žiadosti určené pre používateľa.

Príklad: "example"
pricePriceData nullPovinné

Informácie o cene vo vybranom kontexte.

Príklad: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
price_versionCelé čísloPovinné

Aktuálna verzia ceny na riadenie súbežných zmien.

Príklad: 1
primary_category_idReťazec nullPovinné

Identifikátor hlavnej kategórie.

Príklad: "example"
primary_media_idReťazec nullPovinné

Identifikátor hlavného mediálneho súboru.

Príklad: "example"
publishedLogická hodnotaPovinné

Či je zdroj zverejnený.

Príklad: false
skuReťazecPovinné

Skladový kód položky.

Príklad: "example"
slugReťazec nullPovinné

Úsek cesty URL vo vybranom jazyku.

Príklad: "example"
tax_category_idReťazecPovinné

Identifikátor daňovej kategórie.

Príklad: "example"
updated_atReťazecPovinné

Čas poslednej aktualizácie.

format: "date-time"
Príklad: "2026-01-01T12:00:00Z"
variants_enabledLogická hodnotaPovinné

Či produkt používa varianty.

Príklad: false
versionCelé čísloPovinné

Verzia zdroja používaná na riadenie súbežných zmien.

Príklad: 1

Ďalšie polia: Nie

Upraviť — Produkty — Telo požiadavky

ProductUpdate · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
brand_idReťazec nullVoliteľné

Identifikátor značky.

Reťazec:minLength: 1maxLength: 63
conditionReťazecVoliteľné

Stav produktu.

Obmedzenia
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
descriptionReťazec nullVoliteľné

Opis vo vybranom jazyku.

Reťazec:maxLength: 100000
Príklad: null
expected_variant_price_versionsObjektĎalšie polia: Celé číslo
minimum: 0maximum: 9223372036854775807
Voliteľné

Skôr načítané verzie cien s identifikátormi variantov ako kľúčmi.

maxProperties: 250
Obmedzenia
propertyNames
{"maxLength": 63, "minLength": 1}
expected_versionCelé čísloPovinné

Verzia načítaná pred zápisom; pri nezhode sa aktualizácia odmietne.

minimum: 1maximum: 9223372036854775807
Príklad: 1
feature_value_idsPole <Reťazec> Voliteľné

Identifikátory vybraných hodnôt vlastností.

maxItems: 1000
Pole:minLength: 1maxLength: 63
identifiersProductIdentifiers nullVoliteľné

Identifikačné kódy produktu.

market_idsPole <Reťazec> Voliteľné

Identifikátory vybraných trhov.

maxItems: 1000
Pole:minLength: 1maxLength: 63
media_idsPole <Reťazec> Voliteľné

Identifikátory už existujúcich mediálnych súborov.

maxItems: 20
Pole:minLength: 1maxLength: 63
meta_descriptionReťazec nullVoliteľné

Opis pre vyhľadávače vo vybranom jazyku.

Reťazec:maxLength: 160
meta_keywordsPole <Reťazec> nullVoliteľné

Kľúčové slová pre vyhľadávače vo vybranom jazyku.

Pole:maxItems: 20
Pole / Pole:maxLength: 50
meta_titleReťazec nullVoliteľné

Titulok pre vyhľadávače vo vybranom jazyku.

Reťazec:maxLength: 70
nameReťazec nullVoliteľné

Názov zdroja v príslušnom kontexte.

Reťazec:maxLength: 300
Príklad: null
pricingProductPrice Voliteľné

Nastavenie cien a ich verzie na riadenie súbežných zmien.

Príklad: {"amount":"0.00","currency":"PLN","expected_price_list_version":1,"expected_version":0,"kind":"base","price_list_id":"example","tax_included":true}
primary_category_idReťazec nullVoliteľné

Identifikátor hlavnej kategórie.

Reťazec:minLength: 1maxLength: 63
publishedLogická hodnotaVoliteľné

Či je zdroj zverejnený.

skuReťazecVoliteľné

Skladový kód položky.

minLength: 1maxLength: 100
Obmedzenia
pattern
"^\\S+$"
Príklad: "example"
slugReťazec nullVoliteľné

Úsek cesty URL vo vybranom jazyku.

Reťazec:maxLength: 160
tax_category_idReťazec nullVoliteľné

Identifikátor daňovej kategórie.

Reťazec:minLength: 1maxLength: 63
variant_value_idsPole <Reťazec> Voliteľné

Identifikátory vybraných hodnôt variantov.

maxItems: 250
Pole:minLength: 1maxLength: 63
variants_enabledLogická hodnotaVoliteľné

Či produkt používa varianty.

Ďalšie polia: Nie