Veri şemaları: Varyantlar ve seçenekler

Veri şemaları: Varyantlar ve seçenekler. API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.

Veri şemaları

Listele · Ürün varyantları — Varyantlar ve seçenekler — Yanıt

ApiResponse_list_ProductVariantData__ · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.

dataDizi <ProductVariantData > Zorunlu: Yanıt örneği · ApiResponse_list_ProductVariantData__.

Örnek: [{"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 Zorunlu: Yanıt üst verileri.

Örnek: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Ek alanlar: Hayır

Listele · Seçenekler — Varyantlar ve seçenekler — Yanıt

ApiResponse_list_VariantOptionData__ · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.

dataDizi <shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData > Zorunlu: Yanıt örneği · ApiResponse_list_VariantOptionData__.

Örnek: [{"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 Zorunlu: Yanıt üst verileri.

Örnek: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Ek alanlar: Hayır

Listele · Seçenek değerleri — Varyantlar ve seçenekler — Yanıt

ApiResponse_list_VariantValueData__ · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.

dataDizi <VariantValueData > Zorunlu: Yanıt örneği · ApiResponse_list_VariantValueData__.

Örnek: [{"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 Zorunlu: Yanıt üst verileri.

Örnek: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Ek alanlar: Hayır

Getir · Ürün varyantları — Varyantlar ve seçenekler — Yanıt

ApiResponse_ProductVariantData_ · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.

dataProductVariantData Zorunlu: Yanıt örneği · ProductVariantData.

Örnek: {"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 Zorunlu: Yanıt üst verileri.

Örnek: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Ek alanlar: Hayır

Getir · Seçenekler — Varyantlar ve seçenekler — Yanıt

ApiResponse_VariantOptionData_ · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.

datashopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData Zorunlu: Yanıt örneği · shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData.

Örnek: {"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 Zorunlu: Yanıt üst verileri.

Örnek: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Ek alanlar: Hayır

Getir · Seçenek değerleri — Varyantlar ve seçenekler — Yanıt

ApiResponse_VariantValueData_ · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.

dataVariantValueData Zorunlu: Yanıt örneği · VariantValueData.

Örnek: {"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 Zorunlu: Yanıt üst verileri.

Örnek: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Ek alanlar: Hayır

Getir · Seçenekler — Varyantlar ve seçenekler — Yanıt

shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.

created_atDizeZorunlu

Oluşturulma zamanı.

format: "date-time"

Örnek: "2026-01-01T12:00:00Z"

idDizeZorunlu

Kaynak tanımlayıcısı; döndürüldüğü biçimi koruyun. (shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData).

Örnek: "example"

nameDize nullZorunlu

İlgili bağlamdaki kaynak adı.

Örnek: "Example"

numberDizeZorunlu

Kullanıcıya gösterilen sipariş veya talep numarası.

Örnek: "example"

positionTam sayıZorunlu

Sıralı koleksiyondaki konum.

Örnek: 1

selection_typeDizeZorunlu

İzin verilen özellik değeri seçim biçimi.

Kısıtlamalar

enum: ["button", "dropdown"]

Örnek: "button"

updated_atDizeZorunlu

Son güncelleme zamanı.

format: "date-time"

Örnek: "2026-01-01T12:00:00Z"

value_presentation_typeDizeZorunlu

Sözlük değerlerinin sunulma biçimi.

Kısıtlamalar

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

Örnek: "text"

versionTam sayıZorunlu

Eşzamanlılık denetiminde kullanılan kaynak sürümü.

Örnek: 1

Ek alanlar: Hayır

Getir · Ürün varyantları — Varyantlar ve seçenekler — Yanıt

ProductVariantData · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.

activeMantıksal değerZorunlu: Kaynağın etkin olup olmadığı.

Örnek: true
created_atDizeZorunlu: Oluşturulma zamanı.

format: "date-time"

Örnek: "2026-01-01T12:00:00Z"
idDizeZorunlu: Kaynak tanımlayıcısı; döndürüldüğü biçimi koruyun. (ProductVariantData).

Örnek: "example"
is_defaultMantıksal değerZorunlu: Bu seçeneğin varsayılan olup olmadığı.

Örnek: true
media_idsDizi <Dize> Zorunlu: Mevcut medya dosyalarının tanımlayıcıları.

Örnek: ["example"]
positionTam sayıZorunlu: Sıralı koleksiyondaki konum.

Örnek: 1
pricingVariantPricingData Zorunlu: Fiyat yapılandırması ve eşzamanlılık sürümleri.

Örnek: {"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_idDize nullZorunlu: Birincil medya dosyası tanımlayıcısı.

Örnek: "example"
product_idDizeZorunlu: Ürün tanımlayıcısı.

Örnek: "example"
skuDizeZorunlu: Stok tutma birimi kodu.

Örnek: "example"
updated_atDizeZorunlu: Son güncelleme zamanı.

format: "date-time"

Örnek: "2026-01-01T12:00:00Z"
valuesDizi <VariantChoiceData > Zorunlu: Sözlük değerleri.

Örnek: [{"option_id":"example","option_name":"example","value":"example","value_id":"example"}]
versionTam sayıZorunlu: Eşzamanlılık denetiminde kullanılan kaynak sürümü.

Örnek: 1

Ek alanlar: Hayır

Sözlük değerleri

VariantChoiceData · Şema · Veri şemaları: Varyantlar ve seçenekler

option_idDizeZorunlu: Varyant seçeneği tanımlayıcısı.

Örnek: "example"
option_nameDize nullZorunlu: Varyant seçeneği adı.

Örnek: "example"
valueDize nullZorunlu: İçinde bulunduğu şemanın tanımladığı değer.

Örnek: "example"
value_idDizeZorunlu: Sözlük değeri tanımlayıcısı.

Örnek: "example"

Ek alanlar: Hayır

Oluştur · Ürün varyantları — Varyantlar ve seçenekler — İstek gövdesi

VariantCreate · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.

activeMantıksal değerİsteğe bağlı

Kaynağın etkin olup olmadığı.

Varsayılan: true

expected_versionTam sayıZorunlu

Yazmadan önce okunan sürüm; uyuşmazlık güncellemenin reddedilmesine yol açar.

minimum: 1maximum: 9223372036854775807

Örnek: 1

is_defaultMantıksal değerİsteğe bağlı

Bu seçeneğin varsayılan olup olmadığı.

media_idsDizi <Dize> İsteğe bağlı

Mevcut medya dosyalarının tanımlayıcıları.

maxItems: 20

Dizi:minLength: 1maxLength: 63

pricingVariantPrice İsteğe bağlı

Fiyat yapılandırması ve eşzamanlılık sürümleri.

skuDizeİsteğe bağlı

Stok tutma birimi kodu.

minLength: 1maxLength: 100

Kısıtlamalar

pattern: "^\\S+$"

value_idsDizi <Dize> Zorunlu

Sözlük değerlerinin tanımlayıcıları.

minItems: 1maxItems: 250

Dizi:minLength: 1maxLength: 63

Örnek: ["example"]

Ek alanlar: Hayır

Oluştur · Seçenekler — Varyantlar ve seçenekler — İstek gövdesi

VariantOptionCreate · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.

nameDizeZorunlu

İlgili bağlamdaki kaynak adı.

minLength: 1maxLength: 120

Kısıtlamalar

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

Örnek: "Example"

selection_typeDizeİsteğe bağlı

İzin verilen özellik değeri seçim biçimi.

Kısıtlamalar

enum: ["button", "dropdown"]

Varsayılan: "button"

value_presentation_typeDizeİsteğe bağlı

Sözlük değerlerinin sunulma biçimi.

Kısıtlamalar

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

Varsayılan: "text"

Ek alanlar: Hayır

Güncelle · Seçenekler — Varyantlar ve seçenekler — İstek gövdesi

VariantOptionUpdate · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.

expected_versionTam sayıZorunlu

Yazmadan önce okunan sürüm; uyuşmazlık güncellemenin reddedilmesine yol açar.

minimum: 1maximum: 9223372036854775807

Örnek: 1

nameDize nullİsteğe bağlı

İlgili bağlamdaki kaynak adı.

Dize:minLength: 1maxLength: 120

Kısıtlamalar · Dize 1

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

Örnek: "Example"

selection_typeDizeİsteğe bağlı

İzin verilen özellik değeri seçim biçimi.

Kısıtlamalar

enum: ["button", "dropdown"]

value_presentation_typeDizeİsteğe bağlı

Sözlük değerlerinin sunulma biçimi.

Kısıtlamalar

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

Ek alanlar: Hayır

Fiyat yapılandırması ve eşzamanlılık sürümleri

VariantPrice · Şema · Veri şemaları: Varyantlar ve seçenekler

amountDize nullZorunlu

JSON dizesi olarak kodlanan ondalık tutar; yalnızca izin verilen yerlerde null olabilir.

Dize:maxLength: 20

Kısıtlamalar · Dize 1

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

Örnek: "0.00"

currencyDizeZorunlu

Tutarın para birimi kodu.

Kısıtlamalar

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

Örnek: "PLN"

expected_price_list_versionTam sayıZorunlu

Bu yazma işlemi için gereken, önceden okunmuş fiyat listesi sürümü.

minimum: 1maximum: 9223372036854775807

Örnek: 1

expected_product_versionTam sayıZorunlu

Bu yazma işlemi için gereken, önceden okunmuş ürün sürümü.

minimum: 0maximum: 9223372036854775807

Örnek: 1

expected_versionTam sayıZorunlu

Yazmadan önce okunan sürüm; uyuşmazlık güncellemenin reddedilmesine yol açar.

minimum: 0maximum: 9223372036854775807

Örnek: 0

kindDizeZorunlu

İzin verilen değerlerle tanımlanan veri yapısı çeşidi.

Kısıtlamalar

enum: ["base_adjustment", "market_fixed"]

Örnek: "base_adjustment"

price_list_idDizeZorunlu

Fiyat listesi tanımlayıcısı.

minLength: 1maxLength: 63

Örnek: "example"

Ek alanlar: Hayır

Fiyat yapılandırması ve eşzamanlılık sürümleri

VariantPricingData · Şema · Veri şemaları: Varyantlar ve seçenekler

base_adjustmentMoneyData Zorunlu: Taban fiyata göre fiyat düzeltmesi.

Örnek: {"amount":"0.00","currency":"PLN","minor_units":2}
market_priceMoneyData nullZorunlu: Seçilen pazarın fiyatı.

Örnek: null
pricePriceData nullZorunlu: Seçilen bağlamdaki fiyat bilgileri.

Örnek: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
product_versionTam sayıZorunlu: Eşzamanlılık denetimi için geçerli ürün sürümü.

Örnek: 1
versionTam sayıZorunlu: Eşzamanlılık denetiminde kullanılan kaynak sürümü.

Örnek: 1

Ek alanlar: Hayır

Güncelle · Ürün varyantları — Varyantlar ve seçenekler — İstek gövdesi

VariantUpdate · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.

activeMantıksal değerİsteğe bağlı

Kaynağın etkin olup olmadığı.

expected_versionTam sayıZorunlu

Yazmadan önce okunan sürüm; uyuşmazlık güncellemenin reddedilmesine yol açar.

minimum: 1maximum: 9223372036854775807

Örnek: 1

is_defaultMantıksal değerİsteğe bağlı

Bu seçeneğin varsayılan olup olmadığı.

media_idsDizi <Dize> İsteğe bağlı

Mevcut medya dosyalarının tanımlayıcıları.

maxItems: 20

Dizi:minLength: 1maxLength: 63

pricingVariantPrice İsteğe bağlı

Fiyat yapılandırması ve eşzamanlılık sürümleri.

Örnek:

{"amount":"0.00","currency":"PLN","expected_price_list_version":1,"expected_product_version":1,"expected_version":0,"kind":"base_adjustment","price_list_id":"example"}

skuDizeİsteğe bağlı

Stok tutma birimi kodu.

minLength: 1maxLength: 100

Kısıtlamalar

pattern: "^\\S+$"

Örnek: "example"

Ek alanlar: Hayır

Oluştur · Seçenek değerleri — Varyantlar ve seçenekler — İstek gövdesi

VariantValueCreate · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.

color_hexDize nullİsteğe bağlı

Onaltılık kodla ifade edilen renk.

Kısıtlamalar · Dize 1

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

expected_versionTam sayıZorunlu

Yazmadan önce okunan sürüm; uyuşmazlık güncellemenin reddedilmesine yol açar.

minimum: 1maximum: 9223372036854775807

Örnek: 1

valueDizeZorunlu

İçinde bulunduğu şemanın tanımladığı değer.

minLength: 1maxLength: 180

Kısıtlamalar

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

Örnek: "Example"

Ek alanlar: Hayır

Getir · Seçenek değerleri — Varyantlar ve seçenekler — Yanıt

VariantValueData · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.

color_hexDize nullZorunlu: Onaltılık kodla ifade edilen renk.

Örnek: "#008855"
created_atDizeZorunlu: Oluşturulma zamanı.

format: "date-time"

Örnek: "2026-01-01T12:00:00Z"
idDizeZorunlu: Kaynak tanımlayıcısı; döndürüldüğü biçimi koruyun. (VariantValueData).

Örnek: "example"
image_media_idDize nullZorunlu: Seçilen görsel dosyasının tanımlayıcısı.

Örnek: null
numberDizeZorunlu: Kullanıcıya gösterilen sipariş veya talep numarası.

Örnek: "example"
option_idDizeZorunlu: Varyant seçeneği tanımlayıcısı.

Örnek: "example"
positionTam sayıZorunlu: Sıralı koleksiyondaki konum.

Örnek: 1
sku_codeDizeZorunlu: Stok tutma birimi kodu.

Örnek: "example"
updated_atDizeZorunlu: Son güncelleme zamanı.

format: "date-time"

Örnek: "2026-01-01T12:00:00Z"
valueDize nullZorunlu: İçinde bulunduğu şemanın tanımladığı değer.

Örnek: "example"
versionTam sayıZorunlu: Eşzamanlılık denetiminde kullanılan kaynak sürümü.

Örnek: 1

Ek alanlar: Hayır

Güncelle · Seçenek değerleri — Varyantlar ve seçenekler — İstek gövdesi

VariantValueUpdate · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.

color_hexDize nullİsteğe bağlı

Onaltılık kodla ifade edilen renk.

Kısıtlamalar · Dize 1

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

expected_versionTam sayıZorunlu

Yazmadan önce okunan sürüm; uyuşmazlık güncellemenin reddedilmesine yol açar.

minimum: 1maximum: 9223372036854775807

Örnek: 1

valueDize nullİsteğe bağlı

İçinde bulunduğu şemanın tanımladığı değer.

Dize:minLength: 1maxLength: 180

Kısıtlamalar · Dize 1

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

Örnek: "Example"

Ek alanlar: Hayır