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

Схеми на данните: Варианти и опции. Полета, типове и ограничения на данните, приемани или връщани от API.

Схеми на данните

Списък · Варианти на продукта — Варианти и опции — Отговор

ApiResponse_list_ProductVariantData__ · Полета, типове и ограничения на данните, приемани или връщани от API.

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"}

Допълнителни полета: Не

Списък · Опции — Варианти и опции — Отговор

ApiResponse_list_VariantOptionData__ · Полета, типове и ограничения на данните, приемани или връщани от API.

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"}

Допълнителни полета: Не

Списък · Стойности на опции — Варианти и опции — Отговор

ApiResponse_list_VariantValueData__ · Полета, типове и ограничения на данните, приемани или връщани от API.

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"}

Допълнителни полета: Не

Получаване · Варианти на продукта — Варианти и опции — Отговор

ApiResponse_ProductVariantData_ · Полета, типове и ограничения на данните, приемани или връщани от API.

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"}

Допълнителни полета: Не

Получаване · Опции — Варианти и опции — Отговор

ApiResponse_VariantOptionData_ · Полета, типове и ограничения на данните, приемани или връщани от API.

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"}

Допълнителни полета: Не

Получаване · Стойности на опции — Варианти и опции — Отговор

ApiResponse_VariantValueData_ · Полета, типове и ограничения на данните, приемани или връщани от API.

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"}

Допълнителни полета: Не

Получаване · Опции — Варианти и опции — Отговор

shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData · Полета, типове и ограничения на данните, приемани или връщани от API.

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

Допълнителни полета: Не

Получаване · Варианти на продукта — Варианти и опции — Отговор

ProductVariantData · Полета, типове и ограничения на данните, приемани или връщани от API.

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

Допълнителни полета: Не

Стойности от справочника

VariantChoiceData · Схема · Схеми на данните: Варианти и опции

option_idНизЗадължително: Идентификатор на опцията за вариант.

Пример: "example"
option_nameНиз nullЗадължително: Име на опцията за вариант.

Пример: "example"
valueНиз nullЗадължително: Стойност, описана от околната схема.

Пример: "example"
value_idНизЗадължително: Идентификатор на стойност от справочника.

Пример: "example"

Допълнителни полета: Не

Създаване · Варианти на продукта — Варианти и опции — Тяло на заявката

VariantCreate · Полета, типове и ограничения на данните, приемани или връщани от API.

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"]

Допълнителни полета: Не

Създаване · Опции — Варианти и опции — Тяло на заявката

VariantOptionCreate · Полета, типове и ограничения на данните, приемани или връщани от API.

nameНизЗадължително

Име на ресурса в съответния контекст.

minLength: 1maxLength: 120

Ограничения

pattern: "^[^\\x00]*$"

Пример: "Example"

selection_typeНизНезадължително

Разрешен режим за избор на стойности на характеристика.

Ограничения

enum: ["button", "dropdown"]

По подразбиране: "button"

value_presentation_typeНизНезадължително

Начин на показване на стойностите от справочника.

Ограничения

enum: ["text", "color", "image"]

По подразбиране: "text"

Допълнителни полета: Не

Промяна · Опции — Варианти и опции — Тяло на заявката

VariantOptionUpdate · Полета, типове и ограничения на данните, приемани или връщани от API.

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"]

Допълнителни полета: Не

Настройки за ценообразуване и версии за контрол на едновременни записи

VariantPrice · Схема · Схеми на данните: Варианти и опции

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"

Допълнителни полета: Не

Настройки за ценообразуване и версии за контрол на едновременни записи

VariantPricingData · Схема · Схеми на данните: Варианти и опции

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

Допълнителни полета: Не

Промяна · Варианти на продукта — Варианти и опции — Тяло на заявката

VariantUpdate · Полета, типове и ограничения на данните, приемани или връщани от API.

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"

Допълнителни полета: Не

Създаване · Стойности на опции — Варианти и опции — Тяло на заявката

VariantValueCreate · Полета, типове и ограничения на данните, приемани или връщани от API.

color_hexНиз nullНезадължително

Цвят, представен с шестнадесетичен код.

Ограничения · Низ 1

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

expected_versionЦяло числоЗадължително

Версията, прочетена преди записа; несъответствие отхвърля актуализацията.

minimum: 1maximum: 9223372036854775807

Пример: 1

valueНизЗадължително

Стойност, описана от околната схема.

minLength: 1maxLength: 180

Ограничения

pattern: "^[^\\x00]*$"

Пример: "Example"

Допълнителни полета: Не

Получаване · Стойности на опции — Варианти и опции — Отговор

VariantValueData · Полета, типове и ограничения на данните, приемани или връщани от API.

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

Допълнителни полета: Не

Промяна · Стойности на опции — Варианти и опции — Тяло на заявката

VariantValueUpdate · Полета, типове и ограничения на данните, приемани или връщани от API.

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"

Допълнителни полета: Не