Схеми даних: Варіанти й опції

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

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

Приклад: [{"active":true,"created_at":"2026-01-01T12:00:00Z","id":"example","is_default":true,"media_ids":["example"],"position":1,"pricing":{"base_adjustment":{"amount":"0.00","currency":"PLN","minor_units":2},"market_price":null,"price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"product_version":1,"version":1},"primary_media_id":"example","product_id":"example","sku":"example","updated_at":"2026-01-01T12:00:00Z","values":[{"option_id":"example","option_name":"example","value":"example","value_id":"example"}],"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"}

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

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

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

Приклад: [{"created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","position":1,"selection_type":"button","updated_at":"2026-01-01T12:00:00Z","value_presentation_type":"text","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"}

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

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

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

Приклад: [{"color_hex":"#008855","created_at":"2026-01-01T12:00:00Z","id":"example","image_media_id":null,"number":"example","option_id":"example","position":1,"sku_code":"example","updated_at":"2026-01-01T12:00:00Z","value":"example","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"}

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

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

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

Приклад: {"active":true,"created_at":"2026-01-01T12:00:00Z","id":"example","is_default":true,"media_ids":["example"],"position":1,"pricing":{"base_adjustment":{"amount":"0.00","currency":"PLN","minor_units":2},"market_price":null,"price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"product_version":1,"version":1},"primary_media_id":"example","product_id":"example","sku":"example","updated_at":"2026-01-01T12:00:00Z","values":[{"option_id":"example","option_name":"example","value":"example","value_id":"example"}],"version":1}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Обов’язкове

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

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

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

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

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

Приклад: {"created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","position":1,"selection_type":"button","updated_at":"2026-01-01T12:00:00Z","value_presentation_type":"text","version":1}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Обов’язкове

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

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

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

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

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

Приклад: {"color_hex":"#008855","created_at":"2026-01-01T12:00:00Z","id":"example","image_media_id":null,"number":"example","option_id":"example","position":1,"sku_code":"example","updated_at":"2026-01-01T12:00:00Z","value":"example","version":1}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Обов’язкове

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

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

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

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

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

format: "date-time"

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

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

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

Приклад: "example"

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

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

Приклад: "Example"

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

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

Приклад: "example"

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

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

Приклад: 1

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

Дозволений режим вибору значень характеристики.

Обмеження

enum

["button", "dropdown"]

Приклад: "button"

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

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

format: "date-time"

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

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

Спосіб відображення значень довідника.

Обмеження

enum

["text", "color", "image"]

Приклад: "text"

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

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

Приклад: 1

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

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

Чи є ресурс активним.

Приклад: true

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

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

format: "date-time"

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

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

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

Приклад: "example"

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

Чи є цей вибір типовим.

Приклад: true

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

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

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

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

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

Приклад: 1

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

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

Приклад: {"base_adjustment":{"amount":"0.00","currency":"PLN","minor_units":2},"market_price":null,"price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"product_version":1,"version":1}

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

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

Приклад: "example"

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

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

Приклад: "example"

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

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

Приклад: "example"

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

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

format: "date-time"

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

valuesМасив <VariantChoiceData > Обов’язкове

Значення довідника.

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

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

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

Приклад: 1

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

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

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

Приклад: "example"

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

Назва опції варіанта.

Приклад: "example"

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

Значення, описане навколишньою схемою.

Приклад: "example"

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

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

Приклад: "example"

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

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

Чи є ресурс активним.

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

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

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

minimum: 1maximum: 9223372036854775807

Приклад: 1

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

Чи є цей вибір типовим.

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

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

maxItems: 20

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

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

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

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

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

minLength: 1maxLength: 100

Обмеження

pattern

"^\\S+$"

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

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

minItems: 1maxItems: 250

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

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

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

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

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

minLength: 1maxLength: 120

Обмеження

pattern

"^[^\\x00]*$"

Приклад: "Example"

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

Дозволений режим вибору значень характеристики.

Обмеження

enum

["button", "dropdown"]

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

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

Спосіб відображення значень довідника.

Обмеження

enum

["text", "color", "image"]

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

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

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

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

minimum: 1maximum: 9223372036854775807

Приклад: 1

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

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

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

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

pattern

"^[^\\x00]*$"

Приклад: "Example"

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

Дозволений режим вибору значень характеристики.

Обмеження

enum

["button", "dropdown"]

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

Спосіб відображення значень довідника.

Обмеження

enum

["text", "color", "image"]

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

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

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

Рядок:maxLength: 20

Обмеження · Рядок 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_product_versionЦіле числоОбов’язкове

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

minimum: 0maximum: 9223372036854775807

Приклад: 1

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

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

minimum: 0maximum: 9223372036854775807

Приклад: 0

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

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

Обмеження

enum

["base_adjustment", "market_fixed"]

Приклад: "base_adjustment"

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

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

minLength: 1maxLength: 63

Приклад: "example"

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

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

Коригування ціни відносно базової ціни.

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

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

Ціна для вибраного ринку.

Приклад: null

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

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

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

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

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

Приклад: 1

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

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

Приклад: 1

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

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

Чи є ресурс активним.

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

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

minimum: 1maximum: 9223372036854775807

Приклад: 1

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

Чи є цей вибір типовим.

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

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

maxItems: 20

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

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

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

Приклад: {"amount":"0.00","currency":"PLN","expected_price_list_version":1,"expected_product_version":1,"expected_version":0,"kind":"base_adjustment","price_list_id":"example"}

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

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

minLength: 1maxLength: 100

Обмеження

pattern

"^\\S+$"

Приклад: "example"

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

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

Колір у вигляді шістнадцяткового коду.

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

pattern

"^#[0-9A-Fa-f]{6}$"

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

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

minimum: 1maximum: 9223372036854775807

Приклад: 1

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

Значення, описане навколишньою схемою.

minLength: 1maxLength: 180

Обмеження

pattern

"^[^\\x00]*$"

Приклад: "Example"

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

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

Колір у вигляді шістнадцяткового коду.

Приклад: "#008855"

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

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

format: "date-time"

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

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

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

Приклад: "example"

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

Ідентифікатор вибраного зображення з медіатеки.

Приклад: null

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

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

Приклад: "example"

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

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

Приклад: "example"

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

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

Приклад: 1

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

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

Приклад: "example"

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

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

format: "date-time"

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

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

Значення, описане навколишньою схемою.

Приклад: "example"

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

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

Приклад: 1

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

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

Колір у вигляді шістнадцяткового коду.

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

pattern

"^#[0-9A-Fa-f]{6}$"

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

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

minimum: 1maximum: 9223372036854775807

Приклад: 1

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

Значення, описане навколишньою схемою.

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

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

pattern

"^[^\\x00]*$"

Приклад: "Example"

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