İçeriğe atla
ShopentlyLearn

Veri şemaları: Kategoriler

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

Veri şemaları

Getir — Kategoriler — Yanıt

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

Yanıt örneği · CategoryDetailData.

Örnek: {"created_at":"2026-01-01T12:00:00Z","description":"example","id":"example","introduction":"example","is_available":true,"is_visible":false,"meta_description":"example","meta_keywords":["example"],"meta_title":"example","name":"Example","number":"example","parent_id":null,"slug":"example","updated_at":"2026-01-01T12:00:00Z","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

Listele — Kategoriler — Yanıt

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

Yanıt örneği · ApiResponse_list_CategorySummaryData__.

Örnek: [{"created_at":"2026-01-01T12:00:00Z","id":"example","is_available":true,"is_visible":false,"name":"Example","number":"example","parent_id":null,"slug":"example","updated_at":"2026-01-01T12:00:00Z","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

Oluştur — Kategoriler — İstek gövdesi

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

Seçilen dilde açıklama.

Dize:maxLength: 50000
introductionDize nullİsteğe bağlı

Seçilen dilde giriş metni.

Dize:maxLength: 5000
is_visibleMantıksal değerİsteğe bağlı

Kaynağın görünür olup olmadığı.

Varsayılan: false
market_idsDizi <Dize> İsteğe bağlı

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

maxItems: 1000
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: 200
Örnek: "Example"
parent_idDize nullİsteğe bağlı

Üst kategori tanımlayıcısı.

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

Seçilen dilde URL yolu parçası.

Dize:maxLength: 160

Ek alanlar: Hayır

Getir — Kategoriler — Yanıt

CategoryDetailData · 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"
descriptionDize nullZorunlu

Seçilen dilde açıklama.

Örnek: "example"
idDizeZorunlu

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

Örnek: "example"
introductionDize nullZorunlu

Seçilen dilde giriş metni.

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

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

Örnek: true
is_visibleMantıksal değerZorunlu

Kaynağın görünür olup olmadığı.

Örnek: false
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"
parent_idDize nullZorunlu

Üst kategori tanımlayıcısı.

Örnek: null
slugDize nullZorunlu

Seçilen dilde URL yolu parçası.

Örnek: "example"
updated_atDizeZorunlu

Son güncelleme zamanı.

format: "date-time"
Örnek: "2026-01-01T12:00:00Z"
versionTam sayıZorunlu

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

Örnek: 1

Ek alanlar: Hayır

Listele — Kategoriler — Yanıt

CategorySummaryData · 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. (CategorySummaryData).

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

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

Örnek: true
is_visibleMantıksal değerZorunlu

Kaynağın görünür olup olmadığı.

Örnek: false
nameDize nullZorunlu

İlgili bağlamdaki kaynak adı.

Örnek: "Example"
numberDizeZorunlu

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

Örnek: "example"
parent_idDize nullZorunlu

Üst kategori tanımlayıcısı.

Örnek: null
slugDize nullZorunlu

Seçilen dilde URL yolu parçası.

Örnek: "example"
updated_atDizeZorunlu

Son güncelleme zamanı.

format: "date-time"
Örnek: "2026-01-01T12:00:00Z"
versionTam sayıZorunlu

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

Örnek: 1

Ek alanlar: Hayır

Güncelle — Kategoriler — İstek gövdesi

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

Seçilen dilde açıklama.

Dize:maxLength: 50000
expected_versionTam sayıZorunlu

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

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

Seçilen dilde giriş metni.

Dize:maxLength: 5000
is_visibleMantıksal değerİsteğe bağlı

Kaynağın görünür olup olmadığı.

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

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

maxItems: 1000
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: 200
Örnek: "Example"
parent_idDize nullİsteğe bağlı

Üst kategori tanımlayıcısı.

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

Seçilen dilde URL yolu parçası.

Dize:maxLength: 160

Ek alanlar: Hayır