Схеми даних: Товари

dataМасив <ProductSummaryData > Обов’язкове

Приклад відповіді · ApiResponse_list_ProductSummaryData__.

Приклад: [{"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 Обов’язкове

Метадані відповіді.

Приклад: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Додаткові поля: Ні

dataProductDetailData Обов’язкове

Приклад відповіді · ProductDetailData.

Приклад: {"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 Обов’язкове

Метадані відповіді.

Приклад: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Додаткові поля: Ні

available_fromРядок | nullОбов’язкове

Початок доступності.

Рядок:format: "date-time"

Приклад: null

available_untilРядок | nullОбов’язкове

Кінець доступності.

Рядок:format: "date-time"

Приклад: null

is_availableЛогічне значенняОбов’язкове

Чи доступна позиція в цьому контексті.

Приклад: true

Додаткові поля: Ні

amountРядокОбов’язкове

Десяткова сума у вигляді рядка JSON; null лише там, де це дозволено.

Приклад: "0.00"

currencyРядокОбов’язкове

Код валюти суми.

Обмеження

pattern

"^[A-Z]{3}$"

Приклад: "PLN"

minor_unitsЦіле числоОбов’язкове

Кількість десяткових знаків валюти.

minimum: 0maximum: 4

Приклад: 2

tax_includedЛогічне значенняОбов’язкове

Чи включає передана ціна податок.

Приклад: true

Додаткові поля: Ні

currencyРядокОбов’язкове

Код валюти суми.

idРядокОбов’язкове

Ідентифікатор ресурсу; зберігайте його в отриманому вигляді. (PriceListData).

tax_includedЛогічне значенняОбов’язкове

Чи включає передана ціна податок.

versionЦіле числоОбов’язкове

Версія ресурсу для контролю одночасних змін.

Додаткові поля: Ні

brand_idРядок | nullНеобов’язкове

Ідентифікатор бренду.

Рядок:minLength: 1maxLength: 63

conditionРядокНеобов’язкове

Стан товару.

Обмеження

enum

["new", "refurbished", "used", "returned", "display", "damaged"]

За замовчуванням: "new"

descriptionРядок | nullНеобов’язкове

Опис вибраною мовою.

Рядок:maxLength: 100000

feature_value_idsМасив <Рядок> Необов’язкове

Ідентифікатори вибраних значень характеристик.

maxItems: 1000

Масив:minLength: 1maxLength: 63

identifiersProductIdentifiers | nullНеобов’язкове

Ідентифікаційні коди товару.

market_idsМасив <Рядок> Необов’язкове

Ідентифікатори вибраних ринків.

maxItems: 1000

Масив:minLength: 1maxLength: 63

media_idsМасив <Рядок> Необов’язкове

Ідентифікатори вже наявних медіафайлів.

maxItems: 20

Масив:minLength: 1maxLength: 63

meta_descriptionРядок | nullНеобов’язкове

Опис для пошукових систем вибраною мовою.

Рядок:maxLength: 160

meta_keywordsМасив <Рядок> | nullНеобов’язкове

Ключові слова для пошукових систем вибраною мовою.

Масив:maxItems: 20

Масив / Масив:maxLength: 50

meta_titleРядок | nullНеобов’язкове

Заголовок для пошукових систем вибраною мовою.

Рядок:maxLength: 70

nameРядокОбов’язкове

Назва ресурсу у відповідному контексті.

minLength: 1maxLength: 300

Приклад: "Example"

pricingProductPrice Необов’язкове

Налаштування ціни та версії для контролю одночасних змін.

primary_category_idРядок | nullНеобов’язкове

Ідентифікатор основної категорії.

Рядок:minLength: 1maxLength: 63

publishedЛогічне значенняНеобов’язкове

Чи опубліковано ресурс.

За замовчуванням: false

skuРядокОбов’язкове

Код складської облікової одиниці.

minLength: 1maxLength: 100

Обмеження

pattern

"^\\S+$"

Приклад: "example"

slugРядок | nullНеобов’язкове

Сегмент шляху URL вибраною мовою.

Рядок:maxLength: 160

tax_category_idРядок | nullНеобов’язкове

Ідентифікатор податкової категорії.

Рядок:minLength: 1maxLength: 63

variant_value_idsМасив <Рядок> Необов’язкове

Ідентифікатори вибраних значень варіантів.

maxItems: 250

Масив:minLength: 1maxLength: 63

variants_enabledЛогічне значенняНеобов’язкове

Чи використовує товар варіанти.

За замовчуванням: false

Додаткові поля: Ні

availabilityAvailabilityData Обов’язкове

Відомості про доступність у вибраному контексті.

Приклад: {"available_from":null,"available_until":null,"is_available":true}

brand_idРядок | nullОбов’язкове

Ідентифікатор бренду.

Приклад: null

conditionРядокОбов’язкове

Стан товару.

Обмеження

enum

["new", "refurbished", "used", "returned", "display", "damaged"]

Приклад: "new"

created_atРядокОбов’язкове

Час створення.

format: "date-time"

Приклад: "2026-01-01T12:00:00Z"

descriptionРядок | nullОбов’язкове

Опис вибраною мовою.

Приклад: "example"

featuresМасив <FeatureSelectionData > Обов’язкове

Характеристики товару.

Приклад: [{"feature_id":"example","feature_name":"example","value":"example","value_id":"example"}]

idРядокОбов’язкове

Ідентифікатор ресурсу; зберігайте його в отриманому вигляді. (ProductDetailData).

Приклад: "example"

identifiersОб’єктДодаткові поля: РядокОбов’язкове

Ідентифікаційні коди товару.

Приклад: {}

mediaМасив <ProductMediaData > Обов’язкове

Відомості про додані медіафайли.

Приклад: [{"alt_text":"example","id":"example","is_primary":true,"kind":"image","mime_type":"image/jpeg","position":1,"url":"https://example.invalid/product.jpg"}]

meta_descriptionРядок | nullОбов’язкове

Опис для пошукових систем вибраною мовою.

Приклад: "example"

meta_keywordsМасив <Рядок> | nullОбов’язкове

Ключові слова для пошукових систем вибраною мовою.

Приклад: ["example"]

meta_titleРядок | nullОбов’язкове

Заголовок для пошукових систем вибраною мовою.

Приклад: "example"

nameРядок | nullОбов’язкове

Назва ресурсу у відповідному контексті.

Приклад: "Example"

numberРядокОбов’язкове

Зрозумілий користувачу номер замовлення або звернення.

Приклад: "example"

pricePriceData | nullОбов’язкове

Відомості про ціну у вибраному контексті.

Приклад: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}

price_versionЦіле числоОбов’язкове

Поточна версія ціни для контролю одночасних змін.

Приклад: 1

primary_category_idРядок | nullОбов’язкове

Ідентифікатор основної категорії.

Приклад: "example"

primary_media_idРядок | nullОбов’язкове

Ідентифікатор основного медіафайлу.

Приклад: "example"

publishedЛогічне значенняОбов’язкове

Чи опубліковано ресурс.

Приклад: false

skuРядокОбов’язкове

Код складської облікової одиниці.

Приклад: "example"

slugРядок | nullОбов’язкове

Сегмент шляху URL вибраною мовою.

Приклад: "example"

tax_category_idРядокОбов’язкове

Ідентифікатор податкової категорії.

Приклад: "example"

updated_atРядокОбов’язкове

Час останнього оновлення.

format: "date-time"

Приклад: "2026-01-01T12:00:00Z"

variants_enabledЛогічне значенняОбов’язкове

Чи використовує товар варіанти.

Приклад: false

versionЦіле числоОбов’язкове

Версія ресурсу для контролю одночасних змін.

Приклад: 1

Додаткові поля: Ні

eanРядок | nullНеобов’язкове

Ідентифікатор товару EAN.

Рядок:minLength: 1maxLength: 100

isbnРядок | nullНеобов’язкове

Ідентифікатор ISBN.

Рядок:minLength: 1maxLength: 100

mpnРядок | nullНеобов’язкове

Номер виробу виробника.

Рядок:minLength: 1maxLength: 100

upcРядок | nullНеобов’язкове

Ідентифікатор товару UPC.

Рядок:minLength: 1maxLength: 100

Додаткові поля: Ні

alt_textРядок | nullОбов’язкове

Альтернативний текст зображення.

Приклад: "example"

idРядокОбов’язкове

Ідентифікатор ресурсу; зберігайте його в отриманому вигляді. (ProductMediaData).

Приклад: "example"

is_primaryЛогічне значенняОбов’язкове

Чи є ця позиція основною.

Приклад: true

kindРядокОбов’язкове

Різновид структури даних, визначений допустимими значеннями.

Обмеження

enum

["image", "video", "model_3d"]

Приклад: "image"

mime_typeРядокОбов’язкове

Тип вмісту медіафайлу.

Приклад: "image/jpeg"

positionЦіле числоОбов’язкове

Позиція у впорядкованому списку.

Приклад: 1

urlРядок | nullОбов’язкове

URL ресурсу.

Приклад: "https://example.invalid/product.jpg"

Додаткові поля: Ні

amountРядок | nullОбов’язкове

Десяткова сума у вигляді рядка JSON; null лише там, де це дозволено.

Рядок:maxLength: 19

Обмеження · Рядок 1

pattern

"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

Приклад: "0.00"

currencyРядокОбов’язкове

Код валюти суми.

Обмеження

pattern

"^[A-Z]{3}$"

Приклад: "PLN"

expected_price_list_versionЦіле числоОбов’язкове

Попередньо прочитана версія прайс-листа, потрібна для цього запису.

minimum: 1maximum: 9223372036854775807

Приклад: 1

expected_versionЦіле числоОбов’язкове

Версія, прочитана перед записом; невідповідність блокує оновлення.

minimum: 0maximum: 9223372036854775807

Приклад: 0

kindРядокОбов’язкове

Різновид структури даних, визначений допустимими значеннями.

Обмеження

enum

["base", "market_fixed"]

Приклад: "base"

price_list_idРядокОбов’язкове

Ідентифікатор прайс-листа.

minLength: 1maxLength: 63

Приклад: "example"

tax_includedЛогічне значенняОбов’язкове

Чи включає передана ціна податок.

Приклад: true

Додаткові поля: Ні

availabilityAvailabilityData Обов’язкове

Відомості про доступність у вибраному контексті.

Приклад: {"available_from":null,"available_until":null,"is_available":true}

brand_idРядок | nullОбов’язкове

Ідентифікатор бренду.

Приклад: null

conditionРядокОбов’язкове

Стан товару.

Обмеження

enum

["new", "refurbished", "used", "returned", "display", "damaged"]

Приклад: "new"

created_atРядокОбов’язкове

Час створення.

format: "date-time"

Приклад: "2026-01-01T12:00:00Z"

idРядокОбов’язкове

Ідентифікатор ресурсу; зберігайте його в отриманому вигляді. (ProductSummaryData).

Приклад: "example"

nameРядок | nullОбов’язкове

Назва ресурсу у відповідному контексті.

Приклад: "Example"

numberРядокОбов’язкове

Зрозумілий користувачу номер замовлення або звернення.

Приклад: "example"

pricePriceData | nullОбов’язкове

Відомості про ціну у вибраному контексті.

Приклад: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}

price_versionЦіле числоОбов’язкове

Поточна версія ціни для контролю одночасних змін.

Приклад: 1

primary_category_idРядок | nullОбов’язкове

Ідентифікатор основної категорії.

Приклад: "example"

primary_media_idРядок | nullОбов’язкове

Ідентифікатор основного медіафайлу.

Приклад: "example"

publishedЛогічне значенняОбов’язкове

Чи опубліковано ресурс.

Приклад: false

skuРядокОбов’язкове

Код складської облікової одиниці.

Приклад: "example"

slugРядок | nullОбов’язкове

Сегмент шляху URL вибраною мовою.

Приклад: "example"

tax_category_idРядокОбов’язкове

Ідентифікатор податкової категорії.

Приклад: "example"

updated_atРядокОбов’язкове

Час останнього оновлення.

format: "date-time"

Приклад: "2026-01-01T12:00:00Z"

variants_enabledЛогічне значенняОбов’язкове

Чи використовує товар варіанти.

Приклад: false

versionЦіле числоОбов’язкове

Версія ресурсу для контролю одночасних змін.

Приклад: 1

Додаткові поля: Ні

brand_idРядок | nullНеобов’язкове

Ідентифікатор бренду.

Рядок:minLength: 1maxLength: 63

conditionРядокНеобов’язкове

Стан товару.

Обмеження

enum

["new", "refurbished", "used", "returned", "display", "damaged"]

descriptionРядок | nullНеобов’язкове

Опис вибраною мовою.

Рядок:maxLength: 100000

Приклад: null

expected_variant_price_versionsОб’єктДодаткові поля: Ціле число

minimum: 0maximum: 9223372036854775807

Необов’язкове

Попередньо прочитані версії цін із ключами за ідентифікаторами варіантів.

maxProperties: 250

Обмеження

propertyNames

{"maxLength": 63, "minLength": 1}

expected_versionЦіле числоОбов’язкове

Версія, прочитана перед записом; невідповідність блокує оновлення.

minimum: 1maximum: 9223372036854775807

Приклад: 1

feature_value_idsМасив <Рядок> Необов’язкове

Ідентифікатори вибраних значень характеристик.

maxItems: 1000

Масив:minLength: 1maxLength: 63

identifiersProductIdentifiers | nullНеобов’язкове

Ідентифікаційні коди товару.

market_idsМасив <Рядок> Необов’язкове

Ідентифікатори вибраних ринків.

maxItems: 1000

Масив:minLength: 1maxLength: 63

media_idsМасив <Рядок> Необов’язкове

Ідентифікатори вже наявних медіафайлів.

maxItems: 20

Масив:minLength: 1maxLength: 63

meta_descriptionРядок | nullНеобов’язкове

Опис для пошукових систем вибраною мовою.

Рядок:maxLength: 160

meta_keywordsМасив <Рядок> | nullНеобов’язкове

Ключові слова для пошукових систем вибраною мовою.

Масив:maxItems: 20

Масив / Масив:maxLength: 50

meta_titleРядок | nullНеобов’язкове

Заголовок для пошукових систем вибраною мовою.

Рядок:maxLength: 70

nameРядок | nullНеобов’язкове

Назва ресурсу у відповідному контексті.

Рядок:maxLength: 300

Приклад: null

pricingProductPrice Необов’язкове

Налаштування ціни та версії для контролю одночасних змін.

Приклад: {"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Рядок | nullНеобов’язкове

Ідентифікатор основної категорії.

Рядок:minLength: 1maxLength: 63

publishedЛогічне значенняНеобов’язкове

Чи опубліковано ресурс.

skuРядокНеобов’язкове

Код складської облікової одиниці.

minLength: 1maxLength: 100

Обмеження

pattern

"^\\S+$"

Приклад: "example"

slugРядок | nullНеобов’язкове

Сегмент шляху URL вибраною мовою.

Рядок:maxLength: 160

tax_category_idРядок | nullНеобов’язкове

Ідентифікатор податкової категорії.

Рядок:minLength: 1maxLength: 63

variant_value_idsМасив <Рядок> Необов’язкове

Ідентифікатори вибраних значень варіантів.

maxItems: 250

Масив:minLength: 1maxLength: 63

variants_enabledЛогічне значенняНеобов’язкове

Чи використовує товар варіанти.

Додаткові поля: Ні