Přejít na obsah
ShopentlyLearn

Datová schémata: Produkty

Datová schémata: Produkty. Pole, typy a omezení dat přijímaných nebo vracených API.

Datová schémata

Vypsat — Produkty — Odpověď

ApiResponse_list_ProductSummaryData__ · Pole, typy a omezení dat přijímaných nebo vracených API.
dataPole <ProductSummaryData > Povinné

Příklad odpovědi · ApiResponse_list_ProductSummaryData__.

Pří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é

Metadata odpovědi.

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

Další pole: Ne

Načíst — Produkty — Odpověď

ApiResponse_ProductDetailData_ · Pole, typy a omezení dat přijímaných nebo vracených API.
dataProductDetailData Povinné

Příklad odpovědi · ProductDetailData.

Pří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é

Metadata odpovědi.

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

Další pole: Ne

Informace o dostupnosti ve vybraném kontextu

AvailabilityData · Schéma · Datová schémata: Produkty
available_fromŘetězec nullPovinné

Začátek dostupnosti.

Řetězec:format: "date-time"
Příklad: null
available_untilŘetězec nullPovinné

Konec dostupnosti.

Řetězec:format: "date-time"
Příklad: null
is_availableLogická hodnotaPovinné

Zda je položka v tomto kontextu dostupná.

Příklad: true

Další pole: Ne

Informace o ceně ve vybraném kontextu

PriceData · Schéma · Datová schémata: Produkty
amountŘetězecPovinné

Desetinná částka zapsaná jako řetězec JSON; null pouze tam, kde je povoleno.

Příklad: "0.00"
currencyŘetězecPovinné

Kód měny částky.

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

Počet desetinných míst používaných měnou.

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

Zda zadaná cena zahrnuje daň.

Příklad: true

Další pole: Ne

Informace o ceníku

PriceListData · Schéma · Datová schémata: Produkty
currencyŘetězecPovinné

Kód měny částky.

idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen. (PriceListData).

tax_includedLogická hodnotaPovinné

Zda zadaná cena zahrnuje daň.

versionCelé čísloPovinné

Verze zdroje používaná k řízení souběžných změn.

Další pole: Ne

Vytvořit — Produkty — Tělo požadavku

ProductCreate · Pole, typy a omezení dat přijímaných nebo vracených API.
brand_idŘetězec nullVolitelné

Identifikátor značky.

Řetězec:minLength: 1maxLength: 63
conditionŘetězecVolitelné

Stav produktu.

Omezení
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Výchozí hodnota: "new"
descriptionŘetězec nullVolitelné

Popis ve vybraném jazyce.

Řetězec:maxLength: 100000
feature_value_idsPole <Řetězec> Volitelné

Identifikátory vybraných hodnot vlastností.

maxItems: 1000
Pole:minLength: 1maxLength: 63
identifiersProductIdentifiers nullVolitelné

Identifikační kódy produktu.

market_idsPole <Řetězec> Volitelné

Identifikátory vybraných trhů.

maxItems: 1000
Pole:minLength: 1maxLength: 63
media_idsPole <Řetězec> Volitelné

Identifikátory již existujících mediálních souborů.

maxItems: 20
Pole:minLength: 1maxLength: 63
meta_descriptionŘetězec nullVolitelné

Popis pro vyhledávače ve vybraném jazyce.

Řetězec:maxLength: 160
meta_keywordsPole <Řetězec> nullVolitelné

Klíčová slova pro vyhledávače ve vybraném jazyce.

Pole:maxItems: 20
Pole / Pole:maxLength: 50
meta_titleŘetězec nullVolitelné

Titulek pro vyhledávače ve vybraném jazyce.

Řetězec:maxLength: 70
nameŘetězecPovinné

Název zdroje v příslušném kontextu.

minLength: 1maxLength: 300
Příklad: "Example"
pricingProductPrice Volitelné

Nastavení cen a jejich verze pro řízení souběžných změn.

primary_category_idŘetězec nullVolitelné

Identifikátor hlavní kategorie.

Řetězec:minLength: 1maxLength: 63
publishedLogická hodnotaVolitelné

Zda je zdroj zveřejněn.

Výchozí hodnota: false
skuŘetězecPovinné

Skladový kód položky.

minLength: 1maxLength: 100
Omezení
pattern
"^\\S+$"
Příklad: "example"
slugŘetězec nullVolitelné

Úsek cesty URL ve vybraném jazyce.

Řetězec:maxLength: 160
tax_category_idŘetězec nullVolitelné

Identifikátor daňové kategorie.

Řetězec:minLength: 1maxLength: 63
variant_value_idsPole <Řetězec> Volitelné

Identifikátory vybraných hodnot variant.

maxItems: 250
Pole:minLength: 1maxLength: 63
variants_enabledLogická hodnotaVolitelné

Zda produkt používá varianty.

Výchozí hodnota: false

Další pole: Ne

Načíst — Produkty — Odpověď

ProductDetailData · Pole, typy a omezení dat přijímaných nebo vracených API.
availabilityAvailabilityData Povinné

Informace o dostupnosti ve vybraném kontextu.

Příklad: {"available_from":null,"available_until":null,"is_available":true}
brand_idŘetězec nullPovinné

Identifikátor značky.

Příklad: null
conditionŘetězecPovinné

Stav produktu.

Omezení
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Příklad: "new"
created_atŘetězecPovinné

Čas vytvoření.

format: "date-time"
Příklad: "2026-01-01T12:00:00Z"
descriptionŘetězec nullPovinné

Popis ve vybraném jazyce.

Příklad: "example"
featuresPole <FeatureSelectionData > Povinné

Vlastnosti produktu.

Příklad: [{"feature_id":"example","feature_name":"example","value":"example","value_id":"example"}]
idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen. (ProductDetailData).

Příklad: "example"
identifiersObjektDalší pole: ŘetězecPovinné

Identifikační kódy produktu.

Příklad: {}
mediaPole <ProductMediaData > Povinné

Informace o připojených médiích.

Příklad: [{"alt_text":"example","id":"example","is_primary":true,"kind":"image","mime_type":"image/jpeg","position":1,"url":"https://example.invalid/product.jpg"}]
meta_descriptionŘetězec nullPovinné

Popis pro vyhledávače ve vybraném jazyce.

Příklad: "example"
meta_keywordsPole <Řetězec> nullPovinné

Klíčová slova pro vyhledávače ve vybraném jazyce.

Příklad: ["example"]
meta_titleŘetězec nullPovinné

Titulek pro vyhledávače ve vybraném jazyce.

Příklad: "example"
nameŘetězec nullPovinné

Název zdroje v příslušném kontextu.

Příklad: "Example"
numberŘetězecPovinné

Číslo objednávky nebo zákaznického požadavku určené pro uživatele.

Příklad: "example"
pricePriceData nullPovinné

Informace o ceně ve vybraném kontextu.

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

Aktuální verze ceny pro řízení souběžných změn.

Příklad: 1
primary_category_idŘetězec nullPovinné

Identifikátor hlavní kategorie.

Příklad: "example"
primary_media_idŘetězec nullPovinné

Identifikátor hlavního mediálního souboru.

Příklad: "example"
publishedLogická hodnotaPovinné

Zda je zdroj zveřejněn.

Příklad: false
skuŘetězecPovinné

Skladový kód položky.

Příklad: "example"
slugŘetězec nullPovinné

Úsek cesty URL ve vybraném jazyce.

Příklad: "example"
tax_category_idŘetězecPovinné

Identifikátor daňové kategorie.

Příklad: "example"
updated_atŘetězecPovinné

Čas poslední aktualizace.

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

Zda produkt používá varianty.

Příklad: false
versionCelé čísloPovinné

Verze zdroje používaná k řízení souběžných změn.

Příklad: 1

Další pole: Ne

Identifikační kódy produktu

ProductIdentifiers · Schéma · Datová schémata: Produkty
eanŘetězec nullVolitelné

Identifikátor produktu EAN.

Řetězec:minLength: 1maxLength: 100
isbnŘetězec nullVolitelné

Identifikátor ISBN.

Řetězec:minLength: 1maxLength: 100
mpnŘetězec nullVolitelné

Katalogové číslo výrobce.

Řetězec:minLength: 1maxLength: 100
upcŘetězec nullVolitelné

Identifikátor produktu UPC.

Řetězec:minLength: 1maxLength: 100

Další pole: Ne

Informace o připojených médiích

ProductMediaData · Schéma · Datová schémata: Produkty
alt_textŘetězec nullPovinné

Alternativní text obrázku.

Příklad: "example"
idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen. (ProductMediaData).

Příklad: "example"
is_primaryLogická hodnotaPovinné

Zda jde o hlavní položku.

Příklad: true
kindŘetězecPovinné

Varianta datové struktury popsaná povolenými hodnotami.

Omezení
enum
["image", "video", "model_3d"]
Příklad: "image"
mime_typeŘetězecPovinné

Typ obsahu média.

Příklad: "image/jpeg"
positionCelé čísloPovinné

Pozice v seřazeném seznamu.

Příklad: 1
urlŘetězec nullPovinné

URL zdroje.

Příklad: "https://example.invalid/product.jpg"

Další pole: Ne

Nastavení cen a jejich verze pro řízení souběžných změn

ProductPrice · Schéma · Datová schémata: Produkty
amountŘetězec nullPovinné

Desetinná částka zapsaná jako řetězec JSON; null pouze tam, kde je povoleno.

Řetězec:maxLength: 19
Omezení · Řetězec 1
pattern
"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
Příklad: "0.00"
currencyŘetězecPovinné

Kód měny částky.

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

Dříve načtená verze ceníku požadovaná pro tento zápis.

minimum: 1maximum: 9223372036854775807
Příklad: 1
expected_versionCelé čísloPovinné

Verze načtená před zápisem; při neshodě se aktualizace odmítne.

minimum: 0maximum: 9223372036854775807
Příklad: 0
kindŘetězecPovinné

Varianta datové struktury popsaná povolenými hodnotami.

Omezení
enum
["base", "market_fixed"]
Příklad: "base"
price_list_idŘetězecPovinné

Identifikátor ceníku.

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

Zda zadaná cena zahrnuje daň.

Příklad: true

Další pole: Ne

Vypsat — Produkty — Odpověď

ProductSummaryData · Pole, typy a omezení dat přijímaných nebo vracených API.
availabilityAvailabilityData Povinné

Informace o dostupnosti ve vybraném kontextu.

Příklad: {"available_from":null,"available_until":null,"is_available":true}
brand_idŘetězec nullPovinné

Identifikátor značky.

Příklad: null
conditionŘetězecPovinné

Stav produktu.

Omezení
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Příklad: "new"
created_atŘetězecPovinné

Čas vytvoření.

format: "date-time"
Příklad: "2026-01-01T12:00:00Z"
idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen. (ProductSummaryData).

Příklad: "example"
nameŘetězec nullPovinné

Název zdroje v příslušném kontextu.

Příklad: "Example"
numberŘetězecPovinné

Číslo objednávky nebo zákaznického požadavku určené pro uživatele.

Příklad: "example"
pricePriceData nullPovinné

Informace o ceně ve vybraném kontextu.

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

Aktuální verze ceny pro řízení souběžných změn.

Příklad: 1
primary_category_idŘetězec nullPovinné

Identifikátor hlavní kategorie.

Příklad: "example"
primary_media_idŘetězec nullPovinné

Identifikátor hlavního mediálního souboru.

Příklad: "example"
publishedLogická hodnotaPovinné

Zda je zdroj zveřejněn.

Příklad: false
skuŘetězecPovinné

Skladový kód položky.

Příklad: "example"
slugŘetězec nullPovinné

Úsek cesty URL ve vybraném jazyce.

Příklad: "example"
tax_category_idŘetězecPovinné

Identifikátor daňové kategorie.

Příklad: "example"
updated_atŘetězecPovinné

Čas poslední aktualizace.

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

Zda produkt používá varianty.

Příklad: false
versionCelé čísloPovinné

Verze zdroje používaná k řízení souběžných změn.

Příklad: 1

Další pole: Ne

Upravit — Produkty — Tělo požadavku

ProductUpdate · Pole, typy a omezení dat přijímaných nebo vracených API.
brand_idŘetězec nullVolitelné

Identifikátor značky.

Řetězec:minLength: 1maxLength: 63
conditionŘetězecVolitelné

Stav produktu.

Omezení
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
descriptionŘetězec nullVolitelné

Popis ve vybraném jazyce.

Řetězec:maxLength: 100000
Příklad: null
expected_variant_price_versionsObjektDalší pole: Celé číslo
minimum: 0maximum: 9223372036854775807
Volitelné

Dříve načtené verze cen s identifikátory variant jako klíči.

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

Verze načtená před zápisem; při neshodě se aktualizace odmítne.

minimum: 1maximum: 9223372036854775807
Příklad: 1
feature_value_idsPole <Řetězec> Volitelné

Identifikátory vybraných hodnot vlastností.

maxItems: 1000
Pole:minLength: 1maxLength: 63
identifiersProductIdentifiers nullVolitelné

Identifikační kódy produktu.

market_idsPole <Řetězec> Volitelné

Identifikátory vybraných trhů.

maxItems: 1000
Pole:minLength: 1maxLength: 63
media_idsPole <Řetězec> Volitelné

Identifikátory již existujících mediálních souborů.

maxItems: 20
Pole:minLength: 1maxLength: 63
meta_descriptionŘetězec nullVolitelné

Popis pro vyhledávače ve vybraném jazyce.

Řetězec:maxLength: 160
meta_keywordsPole <Řetězec> nullVolitelné

Klíčová slova pro vyhledávače ve vybraném jazyce.

Pole:maxItems: 20
Pole / Pole:maxLength: 50
meta_titleŘetězec nullVolitelné

Titulek pro vyhledávače ve vybraném jazyce.

Řetězec:maxLength: 70
nameŘetězec nullVolitelné

Název zdroje v příslušném kontextu.

Řetězec:maxLength: 300
Příklad: null
pricingProductPrice Volitelné

Nastavení cen a jejich verze pro řízení souběžných změn.

Pří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_idŘetězec nullVolitelné

Identifikátor hlavní kategorie.

Řetězec:minLength: 1maxLength: 63
publishedLogická hodnotaVolitelné

Zda je zdroj zveřejněn.

skuŘetězecVolitelné

Skladový kód položky.

minLength: 1maxLength: 100
Omezení
pattern
"^\\S+$"
Příklad: "example"
slugŘetězec nullVolitelné

Úsek cesty URL ve vybraném jazyce.

Řetězec:maxLength: 160
tax_category_idŘetězec nullVolitelné

Identifikátor daňové kategorie.

Řetězec:minLength: 1maxLength: 63
variant_value_idsPole <Řetězec> Volitelné

Identifikátory vybraných hodnot variant.

maxItems: 250
Pole:minLength: 1maxLength: 63
variants_enabledLogická hodnotaVolitelné

Zda produkt používá varianty.

Další pole: Ne