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

ApiResponse_ProductFileListData_

ApiResponse_ProductFileListData_ · Pole, typy a omezení dat přijímaných nebo vracených API. Po vytvoření upload_id odešlete soubory jako multipart/form-data a přiřaďte je produktu. Stažení vyžaduje token Bearer a oprávnění pro category; odpověď obsahuje bajty souboru bez veřejné adresy a hesla. Pro mode=period zvolte days (1–3650), nebo dosavadní months, nikdy obojí. Podmínky se uloží při nákupu; vrácení peněz odebere přístup jen vrácené položce.
dataProductFileListData Povinné

Obsah úspěšné odpovědi.

Příklad: {"files":[{"category":"digital","created_at":"2026-01-01T12:00:00Z","current_version_id":"00000000-0000-4000-8000-000000000001","file_id":"00000000-0000-4000-8000-000000000001","filename":"manual.pdf","id":"00000000-0000-4000-8000-000000000001","label":"Manual","mime_type":"application/pdf","sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"state":"active","version_number":1}],"product_version":2}
metaContextPageMeta ContextMeta PageMeta RequestMeta Povinné

Metadata odpovědi.

Příklad: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example"}

Další pole: Ne

ApiResponse_ReleaseListData_

ApiResponse_ReleaseListData_ · Pole, typy a omezení dat přijímaných nebo vracených API. Po vytvoření upload_id odešlete soubory jako multipart/form-data a přiřaďte je produktu. Stažení vyžaduje token Bearer a oprávnění pro category; odpověď obsahuje bajty souboru bez veřejné adresy a hesla. Pro mode=period zvolte days (1–3650), nebo dosavadní months, nikdy obojí. Podmínky se uloží při nákupu; vrácení peněz odebere přístup jen vrácené položce.
dataReleaseListData Povinné

Obsah úspěšné odpovědi.

Příklad: {"current_release_id":"00000000-0000-4000-8000-000000000001","product_version":2,"releases":[{"changelog":"Manual update","files":[{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}],"id":"00000000-0000-4000-8000-000000000001","manifest_sha256":"1111111111111111111111111111111111111111111111111111111111111111","published_at":null,"release_sequence":null,"state":"active","version_label":"1.0","withdrawn_at":null}],"update_days":365,"update_mode":"period","update_months":null}
metaContextPageMeta ContextMeta PageMeta RequestMeta Povinné

Metadata odpovědi.

Příklad: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example"}

Další pole: Ne

ApiResponse_UploadData_

ApiResponse_UploadData_ · Pole, typy a omezení dat přijímaných nebo vracených API. Po vytvoření upload_id odešlete soubory jako multipart/form-data a přiřaďte je produktu. Stažení vyžaduje token Bearer a oprávnění pro category; odpověď obsahuje bajty souboru bez veřejné adresy a hesla. Pro mode=period zvolte days (1–3650), nebo dosavadní months, nikdy obojí. Podmínky se uloží při nákupu; vrácení peněz odebere přístup jen vrácené položce.
dataUploadData Povinné

Obsah úspěšné odpovědi.

Příklad: {"category":"digital","expires_at":"2026-01-01T12:00:00Z","filename":"manual.pdf","id":"00000000-0000-4000-8000-000000000001","product_id":"example","received_bytes":46,"sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"status":"ready"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Povinné

Metadata odpovědi.

Příklad: {"request_id":"example"}

Další pole: Ne

ApiResponse[AudienceData]

ApiResponse_AudienceData_ · Načtěte pravidlo přístupu a verzi produktu. První zveřejnění zůstává časovým bodem.
dataAudienceData Povinné

Obsah úspěšné odpovědi.

Příklad: {"anchor_at":"2026-11-03T12:00:00Z","effective_at":"2026-11-03T12:00:00Z","file_id":"00000000-0000-4000-8000-000000000007","file_version_id":"00000000-0000-4000-8000-000000000010","historical_access_preserved":true,"id":"00000000-0000-4000-8000-000000000009","lookback_days":null,"mode":"all_purchasers","next_cursor":null,"order_ids":[],"product_version":3,"revision":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Povinné

Metadata odpovědi.

Příklad: {"request_id":"example-request"}

Další pole: Ne

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

AudienceChange

AudienceChange · Vyberte oprávněné nákupy. Zvolené objednávky musí obsahovat tento produkt zaplacený a nevrácený.
audienceAudienceSelection Povinné

Výslovné pravidlo přístupu ke sdílenému souboru.

Příklad: {"mode":"all_purchasers"}
expected_versionCelé čísloPovinné

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

minimum: 1maximum: 9223372036854775807
Příklad: 1

Další pole: Ne

AudienceData

AudienceData · Načtěte pravidlo přístupu a verzi produktu. První zveřejnění zůstává časovým bodem.
anchor_atŘetězecPovinné

První zveřejnění; změna pravidla datum nemění.

format: "date-time"
Příklad: "2026-11-03T12:00:00Z"
effective_atŘetězecPovinné

Čas zveřejnění tohoto pravidla přístupu.

format: "date-time"
Příklad: "2026-11-03T12:00:00Z"
file_idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen. · file_id

Příklad: "00000000-0000-4000-8000-000000000007"
file_version_idŘetězecPovinné

ID neměnné verze souboru.

Příklad: "00000000-0000-4000-8000-000000000010"
historical_access_preservedLogická hodnotaVolitelné

Dříve přiznaná práva zůstávají po zúžení pravidla.

Výchozí hodnota: truePříklad: true
idŘetězecPovinné

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

Příklad: "00000000-0000-4000-8000-000000000009"
lookback_daysCelé číslo nullPovinné

1–3650 dní před prvním zveřejněním; pouze recent_and_new.

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

Výslovné pravidlo přístupu ke sdílenému souboru. new_purchases / recent_and_new / selected / all_purchasers.

Příklad: "all_purchasers"
next_cursorŘetězec nullPovinné

Hodnota pro pokračování na další stránku, nebo null.

Příklad: null
order_idsPole <Řetězec> Povinné

Objednávky s tímto zaplaceným produktem bez vrácení peněz za něj.

Příklad: []
product_versionCelé čísloPovinné

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

Příklad: 3
revisionCelé čísloPovinné

Postupná revize pravidla přístupu.

Příklad: 1

Další pole: Ne

AudienceSelection

AudienceSelection · Vyberte oprávněné nákupy. Zvolené objednávky musí obsahovat tento produkt zaplacený a nevrácený.
lookback_daysCelé číslo nullVolitelné

1–3650 dní před prvním zveřejněním; pouze recent_and_new.

Celé číslo:minimum: 1maximum: 3650
modeŘetězecPovinné

Výslovné pravidlo přístupu ke sdílenému souboru. new_purchases / recent_and_new / selected / all_purchasers.

Omezení
enum
["new_purchases", "recent_and_new", "selected", "all_purchasers"]
Příklad: "new_purchases"
order_idsPole <Řetězec> Volitelné

Objednávky s tímto zaplaceným produktem bez vrácení peněz za něj.

maxItems: 1000
Omezení · Pole 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Výchozí hodnota: []

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

FileAssign

FileAssign · Pole, typy a omezení dat přijímaných nebo vracených API. Po vytvoření upload_id odešlete soubory jako multipart/form-data a přiřaďte je produktu. Stažení vyžaduje token Bearer a oprávnění pro category; odpověď obsahuje bajty souboru bez veřejné adresy a hesla. Pro mode=period zvolte days (1–3650), nebo dosavadní months, nikdy obojí. Podmínky se uloží při nákupu; vrácení peněz odebere přístup jen vrácené položce.
audienceAudienceSelection nullVolitelné

Výslovné pravidlo přístupu ke sdílenému souboru.

Příklad: {"mode":"new_purchases"}
expected_versionCelé čísloPovinné

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

minimum: 1maximum: 9223372036854775807
Příklad: 1
labelŘetězecVolitelné

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

maxLength: 300
Výchozí hodnota: ""
upload_idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen. · upload_id

format: "uuid"
Příklad: "00000000-0000-4000-8000-000000000001"

Další pole: Ne

FileCategory

FileCategory · Pole, typy a omezení dat přijímaných nebo vracených API. Po vytvoření upload_id odešlete soubory jako multipart/form-data a přiřaďte je produktu. Stažení vyžaduje token Bearer a oprávnění pro category; odpověď obsahuje bajty souboru bez veřejné adresy a hesla. Pro mode=period zvolte days (1–3650), nebo dosavadní months, nikdy obojí. Podmínky se uloží při nákupu; vrácení peněz odebere přístup jen vrácené položce.
Řetězec
Omezení
enum
["internal", "customer_document", "digital"]

Další pole: Ano

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: 30
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

ProductFileData

ProductFileData · Pole, typy a omezení dat přijímaných nebo vracených API. Po vytvoření upload_id odešlete soubory jako multipart/form-data a přiřaďte je produktu. Stažení vyžaduje token Bearer a oprávnění pro category; odpověď obsahuje bajty souboru bez veřejné adresy a hesla. Pro mode=period zvolte days (1–3650), nebo dosavadní months, nikdy obojí. Podmínky se uloží při nákupu; vrácení peněz odebere přístup jen vrácené položce.
categoryFileCategory Povinné

Kategorie souboru: internal / customer_document / digital

Příklad: "digital"
created_atŘetězecPovinné

Čas vytvoření.

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

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen. · current_version_id

format: "uuid"
Příklad: "00000000-0000-4000-8000-000000000001"
file_idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen. · file_id

format: "uuid"
Příklad: "00000000-0000-4000-8000-000000000001"
filenameŘetězecPovinné

Soubor

Příklad: "manual.pdf"
idŘetězecPovinné

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

format: "uuid"
Příklad: "00000000-0000-4000-8000-000000000001"
labelŘetězecPovinné

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

Příklad: "Manual"
mime_typeŘetězecPovinné

Typ obsahu média.

Příklad: "application/pdf"
sha256ŘetězecPovinné

SHA-256 (hex, 64)

Příklad: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesCelé čísloPovinné

Velikost v bajtech

Příklad: 46
stateŘetězecPovinné

Stav

Příklad: "active"
version_numberCelé čísloPovinné

Verze

Příklad: 1

Další pole: Ne

ProductFileListData

ProductFileListData · Pole, typy a omezení dat přijímaných nebo vracených API. Po vytvoření upload_id odešlete soubory jako multipart/form-data a přiřaďte je produktu. Stažení vyžaduje token Bearer a oprávnění pro category; odpověď obsahuje bajty souboru bez veřejné adresy a hesla. Pro mode=period zvolte days (1–3650), nebo dosavadní months, nikdy obojí. Podmínky se uloží při nákupu; vrácení peněz odebere přístup jen vrácené položce.
filesPole <ProductFileData > Povinné

Soubory produktu

Příklad: [{"category":"digital","created_at":"2026-01-01T12:00:00Z","current_version_id":"00000000-0000-4000-8000-000000000001","file_id":"00000000-0000-4000-8000-000000000001","filename":"manual.pdf","id":"00000000-0000-4000-8000-000000000001","label":"Manual","mime_type":"application/pdf","sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"state":"active","version_number":1}]
product_versionCelé čísloPovinné

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

Příklad: 2

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: 30
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
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

ProductVersion

ProductVersion · Tato operace byla vyřazena a vrací 409 beze změny dat. Přístup nastavte pro každý digitální soubor výběrem příjemců.
expected_versionCelé čísloPovinné

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

minimum: 1maximum: 9223372036854775807
Příklad: 1

Další pole: Ne

ReleaseData

ReleaseData · Pole, typy a omezení dat přijímaných nebo vracených API. Po vytvoření upload_id odešlete soubory jako multipart/form-data a přiřaďte je produktu. Stažení vyžaduje token Bearer a oprávnění pro category; odpověď obsahuje bajty souboru bez veřejné adresy a hesla. Pro mode=period zvolte days (1–3650), nebo dosavadní months, nikdy obojí. Podmínky se uloží při nákupu; vrácení peněz odebere přístup jen vrácené položce.
changelogŘetězecPovinné

Popis změn

Příklad: "Manual update"
filesPole <ReleaseFileData > Povinné

Soubory produktu

Příklad: [{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}]
idŘetězecPovinné

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

format: "uuid"
Příklad: "00000000-0000-4000-8000-000000000001"
manifest_sha256Řetězec nullPovinné

Digitální vydání · SHA-256

Příklad: "1111111111111111111111111111111111111111111111111111111111111111"
published_atŘetězec nullPovinné

Publikovat vydání · UTC

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

Digitální vydání · Pozice v seřazeném seznamu.

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

Stav

Příklad: "active"
version_labelŘetězecPovinné

Verze

Příklad: "1.0"
withdrawn_atŘetězec nullPovinné

Stáhnout nabídku · UTC

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

Další pole: Ne

ReleaseDraft

ReleaseDraft · Tato operace byla vyřazena a vrací 409 beze změny dat. Přístup nastavte pro každý digitální soubor výběrem příjemců.
changelogŘetězecVolitelné

Popis změn

maxLength: 20000
Výchozí hodnota: ""
expected_versionCelé čísloPovinné

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

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

Verze · UUID[]

minItems: 1maxItems: 20
Pole:format: "uuid"
Příklad: ["00000000-0000-4000-8000-000000000001"]
version_labelŘetězecPovinné

Verze

minLength: 1maxLength: 64
Příklad: "1.0"

Další pole: Ne

ReleaseFileData

ReleaseFileData · Pole, typy a omezení dat přijímaných nebo vracených API. Po vytvoření upload_id odešlete soubory jako multipart/form-data a přiřaďte je produktu. Stažení vyžaduje token Bearer a oprávnění pro category; odpověď obsahuje bajty souboru bez veřejné adresy a hesla. Pro mode=period zvolte days (1–3650), nebo dosavadní months, nikdy obojí. Podmínky se uloží při nákupu; vrácení peněz odebere přístup jen vrácené položce.
file_idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen. · file_id

format: "uuid"
Příklad: "00000000-0000-4000-8000-000000000001"
sort_orderCelé čísloPovinné

Pozice v seřazeném seznamu.

Příklad: 0
version_idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen. · version_id

format: "uuid"
Příklad: "00000000-0000-4000-8000-000000000001"

Další pole: Ne

ReleaseListData

ReleaseListData · Pole, typy a omezení dat přijímaných nebo vracených API. Po vytvoření upload_id odešlete soubory jako multipart/form-data a přiřaďte je produktu. Stažení vyžaduje token Bearer a oprávnění pro category; odpověď obsahuje bajty souboru bez veřejné adresy a hesla. Pro mode=period zvolte days (1–3650), nebo dosavadní months, nikdy obojí. Podmínky se uloží při nákupu; vrácení peněz odebere přístup jen vrácené položce.
current_release_idŘetězec nullPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen. · current_release_id

Řetězec:format: "uuid"
Příklad: "00000000-0000-4000-8000-000000000001"
product_versionCelé čísloPovinné

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

Příklad: 2
releasesPole <ReleaseData > Povinné

Digitální vydání

Příklad: [{"changelog":"Manual update","files":[{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}],"id":"00000000-0000-4000-8000-000000000001","manifest_sha256":"1111111111111111111111111111111111111111111111111111111111111111","published_at":null,"release_sequence":null,"state":"active","version_label":"1.0","withdrawn_at":null}]
update_daysCelé číslo nullPovinné

Počet dnů (days; null)

Příklad: 365
update_modeŘetězecPovinné

Přístup k budoucím souborům po nákupu: none / period / unlimited

Příklad: "period"
update_monthsCelé číslo nullPovinné

Měsíce (months; null)

Příklad: null

Další pole: Ne

UpdatePolicy

UpdatePolicy · Tato operace byla vyřazena a vrací 409 beze změny dat. Přístup nastavte pro každý digitální soubor výběrem příjemců.
daysCelé číslo nullVolitelné

Počet dnů (1–3650; mode=period; months=null)

Celé číslo:minimum: 1maximum: 3650
Příklad: 365
expected_versionCelé čísloPovinné

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

minimum: 1maximum: 9223372036854775807
Příklad: 1
modeŘetězecPovinné

Přístup k budoucím souborům po nákupu: none / period / unlimited

Omezení
enum
["none", "period", "unlimited"]
Příklad: "period"
monthsCelé číslo nullVolitelné

Měsíce (1–120; mode=period; days=null)

Celé číslo:minimum: 1maximum: 120
Příklad: null

Další pole: Ne

UploadCreate

UploadCreate · Pole, typy a omezení dat přijímaných nebo vracených API. Po vytvoření upload_id odešlete soubory jako multipart/form-data a přiřaďte je produktu. Stažení vyžaduje token Bearer a oprávnění pro category; odpověď obsahuje bajty souboru bez veřejné adresy a hesla. Pro mode=period zvolte days (1–3650), nebo dosavadní months, nikdy obojí. Podmínky se uloží při nákupu; vrácení peněz odebere přístup jen vrácené položce.
filenameŘetězecPovinné

Soubor

minLength: 1maxLength: 255
Příklad: "manual.pdf"
product_idŘetězec nullVolitelné

Identifikátor produktu.

Omezení · Řetězec 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Příklad: "example"
sha256ŘetězecPovinné

SHA-256 (hex, 64)

Omezení
pattern
"^[0-9a-f]{64}$"
Příklad: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesCelé čísloPovinné

Velikost v bajtech

minimum: 1maximum: 262144000
Příklad: 46

Další pole: Ne

UploadData

UploadData · Pole, typy a omezení dat přijímaných nebo vracených API. Po vytvoření upload_id odešlete soubory jako multipart/form-data a přiřaďte je produktu. Stažení vyžaduje token Bearer a oprávnění pro category; odpověď obsahuje bajty souboru bez veřejné adresy a hesla. Pro mode=period zvolte days (1–3650), nebo dosavadní months, nikdy obojí. Podmínky se uloží při nákupu; vrácení peněz odebere přístup jen vrácené položce.
categoryFileCategory Povinné

Kategorie souboru: internal / customer_document / digital

Příklad: "digital"
expires_atŘetězecPovinné

Datum a čas vypršení přístupového údaje.

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

Soubor

Příklad: "manual.pdf"
idŘetězecPovinné

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

format: "uuid"
Příklad: "00000000-0000-4000-8000-000000000001"
product_idŘetězec nullPovinné

Identifikátor produktu.

Příklad: "example"
received_bytesCelé čísloPovinné

Nahrávání… · Velikost v bajtech

Příklad: 46
sha256ŘetězecPovinné

SHA-256 (hex, 64)

Příklad: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesCelé čísloPovinné

Velikost v bajtech

Příklad: 46
statusŘetězecPovinné

Stav přijímaný touto konkrétní operací.

Příklad: "ready"

Další pole: Ne