İçeriğe atla
ShopentlyLearn

Veri şemaları: Ürünler

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

Veri şemaları

Listele — Ürünler — Yanıt

ApiResponse_list_ProductSummaryData__ · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.
dataDizi <ProductSummaryData > Zorunlu

Yanıt örneği · ApiResponse_list_ProductSummaryData__.

Örnek: [{"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 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ünler — Yanıt

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

Yanıt örneği · ProductDetailData.

Örnek: {"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 Zorunlu

Yanıt üst verileri.

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

Ek alanlar: Hayır

Seçilen bağlama ilişkin kullanılabilirlik bilgileri

AvailabilityData · Şema · Veri şemaları: Ürünler
available_fromDize nullZorunlu

Kullanılabilirliğin başlangıcı.

Dize:format: "date-time"
Örnek: null
available_untilDize nullZorunlu

Kullanılabilirliğin sonu.

Dize:format: "date-time"
Örnek: null
is_availableMantıksal değerZorunlu

Öğenin bu bağlamda kullanılabilir olup olmadığı.

Örnek: true

Ek alanlar: Hayır

Seçilen bağlamdaki fiyat bilgileri

PriceData · Şema · Veri şemaları: Ürünler
amountDizeZorunlu

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

Örnek: "0.00"
currencyDizeZorunlu

Tutarın para birimi kodu.

Kısıtlamalar
pattern
"^[A-Z]{3}$"
Örnek: "PLN"
minor_unitsTam sayıZorunlu

Para biriminin kullandığı ondalık basamak sayısı.

minimum: 0maximum: 4
Örnek: 2
tax_includedMantıksal değerZorunlu

Gönderilen fiyatın vergi içerip içermediği.

Örnek: true

Ek alanlar: Hayır

Fiyat listesi bilgileri

PriceListData · Şema · Veri şemaları: Ürünler
currencyDizeZorunlu

Tutarın para birimi kodu.

idDizeZorunlu

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

tax_includedMantıksal değerZorunlu

Gönderilen fiyatın vergi içerip içermediği.

versionTam sayıZorunlu

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

Ek alanlar: Hayır

Oluştur — Ürünler — İstek gövdesi

ProductCreate · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.
brand_idDize nullİsteğe bağlı

Marka tanımlayıcısı.

Dize:minLength: 1maxLength: 63
conditionDizeİsteğe bağlı

Ürünün durumu.

Kısıtlamalar
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Varsayılan: "new"
descriptionDize nullİsteğe bağlı

Seçilen dilde açıklama.

Dize:maxLength: 100000
feature_value_idsDizi <Dize> İsteğe bağlı

Seçilen özellik değerlerinin tanımlayıcıları.

maxItems: 1000
Dizi:minLength: 1maxLength: 63
identifiersProductIdentifiers nullİsteğe bağlı

Ürün tanımlama kodları.

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

Seçilen pazarların tanımlayıcıları.

maxItems: 1000
Dizi:minLength: 1maxLength: 63
media_idsDizi <Dize> İsteğe bağlı

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

maxItems: 20
Dizi:minLength: 1maxLength: 63
meta_descriptionDize nullİsteğe bağlı

Seçilen dilde arama motoru açıklaması.

Dize:maxLength: 160
meta_keywordsDizi <Dize> nullİsteğe bağlı

Seçilen dilde arama motoru anahtar kelimeleri.

Dizi:maxItems: 20
Dizi / Dizi:maxLength: 50
meta_titleDize nullİsteğe bağlı

Seçilen dilde arama motoru başlığı.

Dize:maxLength: 70
nameDizeZorunlu

İlgili bağlamdaki kaynak adı.

minLength: 1maxLength: 300
Örnek: "Example"
pricingProductPrice İsteğe bağlı

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

primary_category_idDize nullİsteğe bağlı

Birincil kategori tanımlayıcısı.

Dize:minLength: 1maxLength: 63
publishedMantıksal değerİsteğe bağlı

Kaynağın yayımlanıp yayımlanmadığı.

Varsayılan: false
skuDizeZorunlu

Stok tutma birimi kodu.

minLength: 1maxLength: 100
Kısıtlamalar
pattern
"^\\S+$"
Örnek: "example"
slugDize nullİsteğe bağlı

Seçilen dilde URL yolu parçası.

Dize:maxLength: 160
tax_category_idDize nullİsteğe bağlı

Vergi kategorisi tanımlayıcısı.

Dize:minLength: 1maxLength: 63
variant_value_idsDizi <Dize> İsteğe bağlı

Seçilen varyant değerlerinin tanımlayıcıları.

maxItems: 250
Dizi:minLength: 1maxLength: 63
variants_enabledMantıksal değerİsteğe bağlı

Ürünün varyant kullanıp kullanmadığı.

Varsayılan: false

Ek alanlar: Hayır

Getir — Ürünler — Yanıt

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

Seçilen bağlama ilişkin kullanılabilirlik bilgileri.

Örnek: {"available_from":null,"available_until":null,"is_available":true}
brand_idDize nullZorunlu

Marka tanımlayıcısı.

Örnek: null
conditionDizeZorunlu

Ürünün durumu.

Kısıtlamalar
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Örnek: "new"
created_atDizeZorunlu

Oluşturulma zamanı.

format: "date-time"
Örnek: "2026-01-01T12:00:00Z"
descriptionDize nullZorunlu

Seçilen dilde açıklama.

Örnek: "example"
featuresDizi <FeatureSelectionData > Zorunlu

Ürün özellikleri.

Örnek: [{"feature_id":"example","feature_name":"example","value":"example","value_id":"example"}]
idDizeZorunlu

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

Örnek: "example"
identifiersNesneEk alanlar: DizeZorunlu

Ürün tanımlama kodları.

Örnek: {}
mediaDizi <ProductMediaData > Zorunlu

Ekli medya bilgileri.

Örnek: [{"alt_text":"example","id":"example","is_primary":true,"kind":"image","mime_type":"image/jpeg","position":1,"url":"https://example.invalid/product.jpg"}]
meta_descriptionDize nullZorunlu

Seçilen dilde arama motoru açıklaması.

Örnek: "example"
meta_keywordsDizi <Dize> nullZorunlu

Seçilen dilde arama motoru anahtar kelimeleri.

Örnek: ["example"]
meta_titleDize nullZorunlu

Seçilen dilde arama motoru başlığı.

Örnek: "example"
nameDize nullZorunlu

İlgili bağlamdaki kaynak adı.

Örnek: "Example"
numberDizeZorunlu

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

Örnek: "example"
pricePriceData nullZorunlu

Seçilen bağlamdaki fiyat bilgileri.

Örnek: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
price_versionTam sayıZorunlu

Eşzamanlılık denetimi için geçerli fiyat sürümü.

Örnek: 1
primary_category_idDize nullZorunlu

Birincil kategori tanımlayıcısı.

Örnek: "example"
primary_media_idDize nullZorunlu

Birincil medya dosyası tanımlayıcısı.

Örnek: "example"
publishedMantıksal değerZorunlu

Kaynağın yayımlanıp yayımlanmadığı.

Örnek: false
skuDizeZorunlu

Stok tutma birimi kodu.

Örnek: "example"
slugDize nullZorunlu

Seçilen dilde URL yolu parçası.

Örnek: "example"
tax_category_idDizeZorunlu

Vergi kategorisi tanımlayıcısı.

Örnek: "example"
updated_atDizeZorunlu

Son güncelleme zamanı.

format: "date-time"
Örnek: "2026-01-01T12:00:00Z"
variants_enabledMantıksal değerZorunlu

Ürünün varyant kullanıp kullanmadığı.

Örnek: false
versionTam sayıZorunlu

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

Örnek: 1

Ek alanlar: Hayır

Ürün tanımlama kodları

ProductIdentifiers · Şema · Veri şemaları: Ürünler
eanDize nullİsteğe bağlı

Ürünün EAN tanımlayıcısı.

Dize:minLength: 1maxLength: 100
isbnDize nullİsteğe bağlı

ISBN tanımlayıcısı.

Dize:minLength: 1maxLength: 100
mpnDize nullİsteğe bağlı

Üretici parça numarası.

Dize:minLength: 1maxLength: 100
upcDize nullİsteğe bağlı

Ürünün UPC tanımlayıcısı.

Dize:minLength: 1maxLength: 100

Ek alanlar: Hayır

Ekli medya bilgileri

ProductMediaData · Şema · Veri şemaları: Ürünler
alt_textDize nullZorunlu

Görselin alternatif metni.

Örnek: "example"
idDizeZorunlu

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

Örnek: "example"
is_primaryMantıksal değerZorunlu

Bunun birincil öğe olup olmadığı.

Örnek: true
kindDizeZorunlu

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

Kısıtlamalar
enum
["image", "video", "model_3d"]
Örnek: "image"
mime_typeDizeZorunlu

Medya içerik türü.

Örnek: "image/jpeg"
positionTam sayıZorunlu

Sıralı koleksiyondaki konum.

Örnek: 1
urlDize nullZorunlu

Kaynak URL'si.

Örnek: "https://example.invalid/product.jpg"

Ek alanlar: Hayır

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

ProductPrice · Şema · Veri şemaları: Ürünler
amountDize nullZorunlu

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

Dize:maxLength: 19
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_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", "market_fixed"]
Örnek: "base"
price_list_idDizeZorunlu

Fiyat listesi tanımlayıcısı.

minLength: 1maxLength: 63
Örnek: "example"
tax_includedMantıksal değerZorunlu

Gönderilen fiyatın vergi içerip içermediği.

Örnek: true

Ek alanlar: Hayır

Listele — Ürünler — Yanıt

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

Seçilen bağlama ilişkin kullanılabilirlik bilgileri.

Örnek: {"available_from":null,"available_until":null,"is_available":true}
brand_idDize nullZorunlu

Marka tanımlayıcısı.

Örnek: null
conditionDizeZorunlu

Ürünün durumu.

Kısıtlamalar
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Örnek: "new"
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. (ProductSummaryData).

Örnek: "example"
nameDize nullZorunlu

İlgili bağlamdaki kaynak adı.

Örnek: "Example"
numberDizeZorunlu

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

Örnek: "example"
pricePriceData nullZorunlu

Seçilen bağlamdaki fiyat bilgileri.

Örnek: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
price_versionTam sayıZorunlu

Eşzamanlılık denetimi için geçerli fiyat sürümü.

Örnek: 1
primary_category_idDize nullZorunlu

Birincil kategori tanımlayıcısı.

Örnek: "example"
primary_media_idDize nullZorunlu

Birincil medya dosyası tanımlayıcısı.

Örnek: "example"
publishedMantıksal değerZorunlu

Kaynağın yayımlanıp yayımlanmadığı.

Örnek: false
skuDizeZorunlu

Stok tutma birimi kodu.

Örnek: "example"
slugDize nullZorunlu

Seçilen dilde URL yolu parçası.

Örnek: "example"
tax_category_idDizeZorunlu

Vergi kategorisi tanımlayıcısı.

Örnek: "example"
updated_atDizeZorunlu

Son güncelleme zamanı.

format: "date-time"
Örnek: "2026-01-01T12:00:00Z"
variants_enabledMantıksal değerZorunlu

Ürünün varyant kullanıp kullanmadığı.

Örnek: false
versionTam sayıZorunlu

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

Örnek: 1

Ek alanlar: Hayır

Güncelle — Ürünler — İstek gövdesi

ProductUpdate · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.
brand_idDize nullİsteğe bağlı

Marka tanımlayıcısı.

Dize:minLength: 1maxLength: 63
conditionDizeİsteğe bağlı

Ürünün durumu.

Kısıtlamalar
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
descriptionDize nullİsteğe bağlı

Seçilen dilde açıklama.

Dize:maxLength: 100000
Örnek: null
expected_variant_price_versionsNesneEk alanlar: Tam sayı
minimum: 0maximum: 9223372036854775807
İsteğe bağlı

Varyant tanımlayıcılarıyla anahtarlanmış, önceden okunmuş fiyat sürümleri.

maxProperties: 250
Kısıtlamalar
propertyNames
{"maxLength": 63, "minLength": 1}
expected_versionTam sayıZorunlu

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

minimum: 1maximum: 9223372036854775807
Örnek: 1
feature_value_idsDizi <Dize> İsteğe bağlı

Seçilen özellik değerlerinin tanımlayıcıları.

maxItems: 1000
Dizi:minLength: 1maxLength: 63
identifiersProductIdentifiers nullİsteğe bağlı

Ürün tanımlama kodları.

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

Seçilen pazarların tanımlayıcıları.

maxItems: 1000
Dizi:minLength: 1maxLength: 63
media_idsDizi <Dize> İsteğe bağlı

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

maxItems: 20
Dizi:minLength: 1maxLength: 63
meta_descriptionDize nullİsteğe bağlı

Seçilen dilde arama motoru açıklaması.

Dize:maxLength: 160
meta_keywordsDizi <Dize> nullİsteğe bağlı

Seçilen dilde arama motoru anahtar kelimeleri.

Dizi:maxItems: 20
Dizi / Dizi:maxLength: 50
meta_titleDize nullİsteğe bağlı

Seçilen dilde arama motoru başlığı.

Dize:maxLength: 70
nameDize nullİsteğe bağlı

İlgili bağlamdaki kaynak adı.

Dize:maxLength: 300
Örnek: null
pricingProductPrice İ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_version":0,"kind":"base","price_list_id":"example","tax_included":true}
primary_category_idDize nullİsteğe bağlı

Birincil kategori tanımlayıcısı.

Dize:minLength: 1maxLength: 63
publishedMantıksal değerİsteğe bağlı

Kaynağın yayımlanıp yayımlanmadığı.

skuDizeİsteğe bağlı

Stok tutma birimi kodu.

minLength: 1maxLength: 100
Kısıtlamalar
pattern
"^\\S+$"
Örnek: "example"
slugDize nullİsteğe bağlı

Seçilen dilde URL yolu parçası.

Dize:maxLength: 160
tax_category_idDize nullİsteğe bağlı

Vergi kategorisi tanımlayıcısı.

Dize:minLength: 1maxLength: 63
variant_value_idsDizi <Dize> İsteğe bağlı

Seçilen varyant değerlerinin tanımlayıcıları.

maxItems: 250
Dizi:minLength: 1maxLength: 63
variants_enabledMantıksal değerİsteğe bağlı

Ürünün varyant kullanıp kullanmadığı.

Ek alanlar: Hayır