Схеми на данните: Продукти

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

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

Списък — Продукти — Отговор

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

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

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

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

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

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

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

Информация за наличността в избрания контекст

AvailabilityData · Схема · Схеми на данните: Продукти

available_fromНиз nullЗадължително: Начало на наличността.

Низ:format: "date-time"

Пример: null
available_untilНиз nullЗадължително: Край на наличността.

Низ:format: "date-time"

Пример: null
is_availableБулева стойностЗадължително: Дали артикулът е наличен в този контекст.

Пример: true

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

Информация за цената в избрания контекст

PriceData · Схема · Схеми на данните: Продукти

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

Десетична сума, кодирана като JSON низ; null само когато е позволено.

Пример: "0.00"

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

Валутен код на сумата.

Ограничения

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

Пример: "PLN"

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

Брой дробни цифри, използвани от валутата.

minimum: 0maximum: 4

Пример: 2

tax_includedБулева стойностЗадължително

Дали подадената цена включва данък.

Пример: true

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

Информация за ценовата листа

PriceListData · Схема · Схеми на данните: Продукти

currencyНизЗадължително: Валутен код на сумата.
idНизЗадължително: Идентификатор на ресурса; запазете го във върнатия вид. (PriceListData).
tax_includedБулева стойностЗадължително: Дали подадената цена включва данък.
versionЦяло числоЗадължително: Версия на ресурса за контрол на едновременни записи.

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

Създаване — Продукти — Тяло на заявката

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

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

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

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

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

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

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

Идентификационни кодове на продукта

ProductIdentifiers · Схема · Схеми на данните: Продукти

eanНиз nullНезадължително: EAN идентификатор на продукта.

Низ:minLength: 1maxLength: 100
isbnНиз nullНезадължително: ISBN идентификатор.

Низ:minLength: 1maxLength: 100
mpnНиз nullНезадължително: Каталожен номер на производителя.

Низ:minLength: 1maxLength: 100
upcНиз nullНезадължително: UPC идентификатор на продукта.

Низ:minLength: 1maxLength: 100

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

Информация за приложените медийни файлове

ProductMediaData · Схема · Схеми на данните: Продукти

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"

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

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

ProductPrice · Схема · Схеми на данните: Продукти

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

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

Списък — Продукти — Отговор

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

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

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

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

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

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Булева стойностНезадължително

Дали продуктът използва варианти.

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