İç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ı

ApiResponse_ProductFileListData_

ApiResponse_ProductFileListData_ · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları. upload_id oluşturulduktan sonra dosyaları multipart/form-data olarak gönderin ve ürüne bağlayın. İndirme için Bearer belirteci ve category izni gerekir; yanıt, herkese açık adres veya parola olmadan dosya baytlarını içerir. mode=period için days (1–3650) veya önceki months seçilir, ikisi birlikte kullanılmaz. Koşullar satın alma sırasında kaydedilir; iade yalnızca iade edilen satırın erişimini kaldırır.
dataProductFileListData Zorunlu

Başarılı yanıtın verileri.

Örnek: {"files":[{"category":"digital","created_at":"2026-01-01T12:00:00Z","current_version_id":"00000000-0000-4000-8000-000000000001","file_id":"00000000-0000-4000-8000-000000000001","filename":"manual.pdf","id":"00000000-0000-4000-8000-000000000001","label":"Manual","mime_type":"application/pdf","sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"state":"active","version_number":1}],"product_version":2}
metaContextPageMeta ContextMeta PageMeta RequestMeta Zorunlu

Yanıt üst verileri.

Örnek: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example"}

Ek alanlar: Hayır

ApiResponse_ReleaseListData_

ApiResponse_ReleaseListData_ · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları. upload_id oluşturulduktan sonra dosyaları multipart/form-data olarak gönderin ve ürüne bağlayın. İndirme için Bearer belirteci ve category izni gerekir; yanıt, herkese açık adres veya parola olmadan dosya baytlarını içerir. mode=period için days (1–3650) veya önceki months seçilir, ikisi birlikte kullanılmaz. Koşullar satın alma sırasında kaydedilir; iade yalnızca iade edilen satırın erişimini kaldırır.
dataReleaseListData Zorunlu

Başarılı yanıtın verileri.

Örnek: {"current_release_id":"00000000-0000-4000-8000-000000000001","product_version":2,"releases":[{"changelog":"Manual update","files":[{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}],"id":"00000000-0000-4000-8000-000000000001","manifest_sha256":"1111111111111111111111111111111111111111111111111111111111111111","published_at":null,"release_sequence":null,"state":"active","version_label":"1.0","withdrawn_at":null}],"update_days":365,"update_mode":"period","update_months":null}
metaContextPageMeta ContextMeta PageMeta RequestMeta Zorunlu

Yanıt üst verileri.

Örnek: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example"}

Ek alanlar: Hayır

ApiResponse_UploadData_

ApiResponse_UploadData_ · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları. upload_id oluşturulduktan sonra dosyaları multipart/form-data olarak gönderin ve ürüne bağlayın. İndirme için Bearer belirteci ve category izni gerekir; yanıt, herkese açık adres veya parola olmadan dosya baytlarını içerir. mode=period için days (1–3650) veya önceki months seçilir, ikisi birlikte kullanılmaz. Koşullar satın alma sırasında kaydedilir; iade yalnızca iade edilen satırın erişimini kaldırır.
dataUploadData Zorunlu

Başarılı yanıtın verileri.

Örnek: {"category":"digital","expires_at":"2026-01-01T12:00:00Z","filename":"manual.pdf","id":"00000000-0000-4000-8000-000000000001","product_id":"example","received_bytes":46,"sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"status":"ready"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Zorunlu

Yanıt üst verileri.

Örnek: {"request_id":"example"}

Ek alanlar: Hayır

ApiResponse[AudienceData]

ApiResponse_AudienceData_ · Erişim kuralını ve ürün sürümünü okuyun. İlk yayın tarihi zaman referansı olarak kalır.
dataAudienceData Zorunlu

Başarılı yanıtın verileri.

Örnek: {"anchor_at":"2026-11-03T12:00:00Z","effective_at":"2026-11-03T12:00:00Z","file_id":"00000000-0000-4000-8000-000000000007","file_version_id":"00000000-0000-4000-8000-000000000010","historical_access_preserved":true,"id":"00000000-0000-4000-8000-000000000009","lookback_days":null,"mode":"all_purchasers","next_cursor":null,"order_ids":[],"product_version":3,"revision":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Zorunlu

Yanıt üst verileri.

Örnek: {"request_id":"example-request"}

Ek alanlar: Hayır

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

AudienceChange

AudienceChange · Uygun satın alımları seçin. Seçili siparişlerde bu ürün ödenmiş ve iade edilmemiş olmalıdır.
audienceAudienceSelection Zorunlu

Paylaşılan dosyanın açık erişim kuralı.

Örnek: {"mode":"all_purchasers"}
expected_versionTam sayıZorunlu

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

minimum: 1maximum: 9223372036854775807
Örnek: 1

Ek alanlar: Hayır

AudienceData

AudienceData · Erişim kuralını ve ürün sürümünü okuyun. İlk yayın tarihi zaman referansı olarak kalır.
anchor_atDizeZorunlu

İlk yayın zamanı; kural değişince değişmez.

format: "date-time"
Örnek: "2026-11-03T12:00:00Z"
effective_atDizeZorunlu

Bu erişim kuralının yayın zamanı.

format: "date-time"
Örnek: "2026-11-03T12:00:00Z"
file_idDizeZorunlu

Kaynak tanımlayıcısı; döndürüldüğü biçimi koruyun. · file_id

Örnek: "00000000-0000-4000-8000-000000000007"
file_version_idDizeZorunlu

Değişmez dosya sürümünün kimliği.

Örnek: "00000000-0000-4000-8000-000000000010"
historical_access_preservedMantıksal değerİsteğe bağlı

Kural daraltıldığında önceden verilen haklar korunur.

Varsayılan: trueÖrnek: true
idDizeZorunlu

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

Örnek: "00000000-0000-4000-8000-000000000009"
lookback_daysTam sayı nullZorunlu

İlk yayından önce 1–3650 gün; yalnızca recent_and_new.

Örnek: null
modeDizeZorunlu

Paylaşılan dosyanın açık erişim kuralı. new_purchases / recent_and_new / selected / all_purchasers.

Örnek: "all_purchasers"
next_cursorDize nullZorunlu

Sonraki sayfanın devam değeri veya null.

Örnek: null
order_idsDizi <Dize> Zorunlu

Bu ürünün ödenmiş ve iade edilmemiş olduğu siparişler.

Örnek: []
product_versionTam sayıZorunlu

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

Örnek: 3
revisionTam sayıZorunlu

Erişim kuralının ardışık revizyonu.

Örnek: 1

Ek alanlar: Hayır

AudienceSelection

AudienceSelection · Uygun satın alımları seçin. Seçili siparişlerde bu ürün ödenmiş ve iade edilmemiş olmalıdır.
lookback_daysTam sayı nullİsteğe bağlı

İlk yayından önce 1–3650 gün; yalnızca recent_and_new.

Tam sayı:minimum: 1maximum: 3650
modeDizeZorunlu

Paylaşılan dosyanın açık erişim kuralı. new_purchases / recent_and_new / selected / all_purchasers.

Kısıtlamalar
enum
["new_purchases", "recent_and_new", "selected", "all_purchasers"]
Örnek: "new_purchases"
order_idsDizi <Dize> İsteğe bağlı

Bu ürünün ödenmiş ve iade edilmemiş olduğu siparişler.

maxItems: 1000
Kısıtlamalar · Dizi 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Varsayılan: []

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

FileAssign

FileAssign · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları. upload_id oluşturulduktan sonra dosyaları multipart/form-data olarak gönderin ve ürüne bağlayın. İndirme için Bearer belirteci ve category izni gerekir; yanıt, herkese açık adres veya parola olmadan dosya baytlarını içerir. mode=period için days (1–3650) veya önceki months seçilir, ikisi birlikte kullanılmaz. Koşullar satın alma sırasında kaydedilir; iade yalnızca iade edilen satırın erişimini kaldırır.
audienceAudienceSelection nullİsteğe bağlı

Paylaşılan dosyanın açık erişim kuralı.

Örnek: {"mode":"new_purchases"}
expected_versionTam sayıZorunlu

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

minimum: 1maximum: 9223372036854775807
Örnek: 1
labelDizeİsteğe bağlı

İlgili bağlamdaki kaynak adı.

maxLength: 300
Varsayılan: ""
upload_idDizeZorunlu

Kaynak tanımlayıcısı; döndürüldüğü biçimi koruyun. · upload_id

format: "uuid"
Örnek: "00000000-0000-4000-8000-000000000001"

Ek alanlar: Hayır

FileCategory

FileCategory · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları. upload_id oluşturulduktan sonra dosyaları multipart/form-data olarak gönderin ve ürüne bağlayın. İndirme için Bearer belirteci ve category izni gerekir; yanıt, herkese açık adres veya parola olmadan dosya baytlarını içerir. mode=period için days (1–3650) veya önceki months seçilir, ikisi birlikte kullanılmaz. Koşullar satın alma sırasında kaydedilir; iade yalnızca iade edilen satırın erişimini kaldırır.
Dize
Kısıtlamalar
enum
["internal", "customer_document", "digital"]

Ek alanlar: Evet

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: 30
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

ProductFileData

ProductFileData · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları. upload_id oluşturulduktan sonra dosyaları multipart/form-data olarak gönderin ve ürüne bağlayın. İndirme için Bearer belirteci ve category izni gerekir; yanıt, herkese açık adres veya parola olmadan dosya baytlarını içerir. mode=period için days (1–3650) veya önceki months seçilir, ikisi birlikte kullanılmaz. Koşullar satın alma sırasında kaydedilir; iade yalnızca iade edilen satırın erişimini kaldırır.
categoryFileCategory Zorunlu

Dosya kategorisi: internal / customer_document / digital

Örnek: "digital"
created_atDizeZorunlu

Oluşturulma zamanı.

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

Kaynak tanımlayıcısı; döndürüldüğü biçimi koruyun. · current_version_id

format: "uuid"
Örnek: "00000000-0000-4000-8000-000000000001"
file_idDizeZorunlu

Kaynak tanımlayıcısı; döndürüldüğü biçimi koruyun. · file_id

format: "uuid"
Örnek: "00000000-0000-4000-8000-000000000001"
filenameDizeZorunlu

Dosya

Örnek: "manual.pdf"
idDizeZorunlu

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

format: "uuid"
Örnek: "00000000-0000-4000-8000-000000000001"
labelDizeZorunlu

İlgili bağlamdaki kaynak adı.

Örnek: "Manual"
mime_typeDizeZorunlu

Medya içerik türü.

Örnek: "application/pdf"
sha256DizeZorunlu

SHA-256 (hex, 64)

Örnek: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesTam sayıZorunlu

Bayt cinsinden boyut

Örnek: 46
stateDizeZorunlu

Durum

Örnek: "active"
version_numberTam sayıZorunlu

Sürüm

Örnek: 1

Ek alanlar: Hayır

ProductFileListData

ProductFileListData · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları. upload_id oluşturulduktan sonra dosyaları multipart/form-data olarak gönderin ve ürüne bağlayın. İndirme için Bearer belirteci ve category izni gerekir; yanıt, herkese açık adres veya parola olmadan dosya baytlarını içerir. mode=period için days (1–3650) veya önceki months seçilir, ikisi birlikte kullanılmaz. Koşullar satın alma sırasında kaydedilir; iade yalnızca iade edilen satırın erişimini kaldırır.
filesDizi <ProductFileData > Zorunlu

Ürün dosyaları

Örnek: [{"category":"digital","created_at":"2026-01-01T12:00:00Z","current_version_id":"00000000-0000-4000-8000-000000000001","file_id":"00000000-0000-4000-8000-000000000001","filename":"manual.pdf","id":"00000000-0000-4000-8000-000000000001","label":"Manual","mime_type":"application/pdf","sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"state":"active","version_number":1}]
product_versionTam sayıZorunlu

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

Örnek: 2

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: 30
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
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

ProductVersion

ProductVersion · Bu işlem kaldırılmıştır ve verileri değiştirmeden 409 döndürür. Her dijital dosyanın erişimini alıcı seçimiyle ayrı olarak ayarlayın.
expected_versionTam sayıZorunlu

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

minimum: 1maximum: 9223372036854775807
Örnek: 1

Ek alanlar: Hayır

ReleaseData

ReleaseData · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları. upload_id oluşturulduktan sonra dosyaları multipart/form-data olarak gönderin ve ürüne bağlayın. İndirme için Bearer belirteci ve category izni gerekir; yanıt, herkese açık adres veya parola olmadan dosya baytlarını içerir. mode=period için days (1–3650) veya önceki months seçilir, ikisi birlikte kullanılmaz. Koşullar satın alma sırasında kaydedilir; iade yalnızca iade edilen satırın erişimini kaldırır.
changelogDizeZorunlu

Değişiklik açıklaması

Örnek: "Manual update"
filesDizi <ReleaseFileData > Zorunlu

Ürün dosyaları

Örnek: [{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}]
idDizeZorunlu

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

format: "uuid"
Örnek: "00000000-0000-4000-8000-000000000001"
manifest_sha256Dize nullZorunlu

Dijital sürümler · SHA-256

Örnek: "1111111111111111111111111111111111111111111111111111111111111111"
published_atDize nullZorunlu

Sürümü yayımla · UTC

Dize:format: "date-time"
Örnek: null
release_sequenceTam sayı nullZorunlu

Dijital sürümler · Sıralı koleksiyondaki konum.

Örnek: null
stateDizeZorunlu

Durum

Örnek: "active"
version_labelDizeZorunlu

Sürüm

Örnek: "1.0"
withdrawn_atDize nullZorunlu

Teklifi geri çek · UTC

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

Ek alanlar: Hayır

ReleaseDraft

ReleaseDraft · Bu işlem kaldırılmıştır ve verileri değiştirmeden 409 döndürür. Her dijital dosyanın erişimini alıcı seçimiyle ayrı olarak ayarlayın.
changelogDizeİsteğe bağlı

Değişiklik açıklaması

maxLength: 20000
Varsayılan: ""
expected_versionTam sayıZorunlu

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

minimum: 1maximum: 9223372036854775807
Örnek: 1
version_idsDizi <Dize> Zorunlu

Sürüm · UUID[]

minItems: 1maxItems: 20
Dizi:format: "uuid"
Örnek: ["00000000-0000-4000-8000-000000000001"]
version_labelDizeZorunlu

Sürüm

minLength: 1maxLength: 64
Örnek: "1.0"

Ek alanlar: Hayır

ReleaseFileData

ReleaseFileData · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları. upload_id oluşturulduktan sonra dosyaları multipart/form-data olarak gönderin ve ürüne bağlayın. İndirme için Bearer belirteci ve category izni gerekir; yanıt, herkese açık adres veya parola olmadan dosya baytlarını içerir. mode=period için days (1–3650) veya önceki months seçilir, ikisi birlikte kullanılmaz. Koşullar satın alma sırasında kaydedilir; iade yalnızca iade edilen satırın erişimini kaldırır.
file_idDizeZorunlu

Kaynak tanımlayıcısı; döndürüldüğü biçimi koruyun. · file_id

format: "uuid"
Örnek: "00000000-0000-4000-8000-000000000001"
sort_orderTam sayıZorunlu

Sıralı koleksiyondaki konum.

Örnek: 0
version_idDizeZorunlu

Kaynak tanımlayıcısı; döndürüldüğü biçimi koruyun. · version_id

format: "uuid"
Örnek: "00000000-0000-4000-8000-000000000001"

Ek alanlar: Hayır

ReleaseListData

ReleaseListData · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları. upload_id oluşturulduktan sonra dosyaları multipart/form-data olarak gönderin ve ürüne bağlayın. İndirme için Bearer belirteci ve category izni gerekir; yanıt, herkese açık adres veya parola olmadan dosya baytlarını içerir. mode=period için days (1–3650) veya önceki months seçilir, ikisi birlikte kullanılmaz. Koşullar satın alma sırasında kaydedilir; iade yalnızca iade edilen satırın erişimini kaldırır.
current_release_idDize nullZorunlu

Kaynak tanımlayıcısı; döndürüldüğü biçimi koruyun. · current_release_id

Dize:format: "uuid"
Örnek: "00000000-0000-4000-8000-000000000001"
product_versionTam sayıZorunlu

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

Örnek: 2
releasesDizi <ReleaseData > Zorunlu

Dijital sürümler

Örnek: [{"changelog":"Manual update","files":[{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}],"id":"00000000-0000-4000-8000-000000000001","manifest_sha256":"1111111111111111111111111111111111111111111111111111111111111111","published_at":null,"release_sequence":null,"state":"active","version_label":"1.0","withdrawn_at":null}]
update_daysTam sayı nullZorunlu

Gün sayısı (days; null)

Örnek: 365
update_modeDizeZorunlu

Satın alma sonrası gelecekteki dosyalara erişim: none / period / unlimited

Örnek: "period"
update_monthsTam sayı nullZorunlu

Ay (months; null)

Örnek: null

Ek alanlar: Hayır

UpdatePolicy

UpdatePolicy · Bu işlem kaldırılmıştır ve verileri değiştirmeden 409 döndürür. Her dijital dosyanın erişimini alıcı seçimiyle ayrı olarak ayarlayın.
daysTam sayı nullİsteğe bağlı

Gün sayısı (1–3650; mode=period; months=null)

Tam sayı:minimum: 1maximum: 3650
Örnek: 365
expected_versionTam sayıZorunlu

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

minimum: 1maximum: 9223372036854775807
Örnek: 1
modeDizeZorunlu

Satın alma sonrası gelecekteki dosyalara erişim: none / period / unlimited

Kısıtlamalar
enum
["none", "period", "unlimited"]
Örnek: "period"
monthsTam sayı nullİsteğe bağlı

Ay (1–120; mode=period; days=null)

Tam sayı:minimum: 1maximum: 120
Örnek: null

Ek alanlar: Hayır

UploadCreate

UploadCreate · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları. upload_id oluşturulduktan sonra dosyaları multipart/form-data olarak gönderin ve ürüne bağlayın. İndirme için Bearer belirteci ve category izni gerekir; yanıt, herkese açık adres veya parola olmadan dosya baytlarını içerir. mode=period için days (1–3650) veya önceki months seçilir, ikisi birlikte kullanılmaz. Koşullar satın alma sırasında kaydedilir; iade yalnızca iade edilen satırın erişimini kaldırır.
filenameDizeZorunlu

Dosya

minLength: 1maxLength: 255
Örnek: "manual.pdf"
product_idDize nullİsteğe bağlı

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

Kısıtlamalar · Dize 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Örnek: "example"
sha256DizeZorunlu

SHA-256 (hex, 64)

Kısıtlamalar
pattern
"^[0-9a-f]{64}$"
Örnek: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesTam sayıZorunlu

Bayt cinsinden boyut

minimum: 1maximum: 262144000
Örnek: 46

Ek alanlar: Hayır

UploadData

UploadData · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları. upload_id oluşturulduktan sonra dosyaları multipart/form-data olarak gönderin ve ürüne bağlayın. İndirme için Bearer belirteci ve category izni gerekir; yanıt, herkese açık adres veya parola olmadan dosya baytlarını içerir. mode=period için days (1–3650) veya önceki months seçilir, ikisi birlikte kullanılmaz. Koşullar satın alma sırasında kaydedilir; iade yalnızca iade edilen satırın erişimini kaldırır.
categoryFileCategory Zorunlu

Dosya kategorisi: internal / customer_document / digital

Örnek: "digital"
expires_atDizeZorunlu

Kimlik bilgisinin sona erme tarihi ve saati.

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

Dosya

Örnek: "manual.pdf"
idDizeZorunlu

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

format: "uuid"
Örnek: "00000000-0000-4000-8000-000000000001"
product_idDize nullZorunlu

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

Örnek: "example"
received_bytesTam sayıZorunlu

Yükleniyor… · Bayt cinsinden boyut

Örnek: 46
sha256DizeZorunlu

SHA-256 (hex, 64)

Örnek: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesTam sayıZorunlu

Bayt cinsinden boyut

Örnek: 46
statusDizeZorunlu

Bu işlemin kabul ettiği durum.

Örnek: "ready"

Ek alanlar: Hayır