Kategoriler
Credential'ın bağlı olduğu mağazaya ait kategori hiyerarşisini okuyun.
Endpointler
/categoriesKategori listesi/categories/{category}Kategori detayıCategories API ne işe yarar?
BYNovax mağazasındaki kategori hiyerarşisini okumak ve ERP/PIM tarafındaki kategori eşlemelerini oluşturmak için kullanılır.
Kategori API read-only'dir; External Commerce API V1 üzerinden kategori oluşturma veya güncelleme yapılmaz.
Gerekli scope
Kategori listeleme ve kategori detay endpointleri products:read scope kullanır.
Liste endpointi
GET /categories kategorileri pagination ile listeler. Varsayılan limit 100'dür ve limit 1 ile 100 arasında sınırlandırılır.
after_id ile sonraki sayfaya geçebilir; active ve parent_id filtreleriyle sonuçları daraltabilirsiniz.
| Query | Amaç |
|---|---|
| limit | Sayfa büyüklüğü |
| after_id | Pagination cursor |
| active | Aktif/pasif kategori filtresi |
| parent_id | Belirli parent altındaki kategoriler |
Kategori response alanları
| Alan | Açıklama |
|---|---|
| id | BYNovax kategori kimliği |
| parent_id | Üst kategori kimliği |
| name | Kategori adı |
| slug | Kategori slug değeri |
| source_key | Kaynak anahtar bilgisi |
| external_id | Varsa dış kaynak ID |
| level | Hiyerarşi seviyesi |
| sort_order | Sıralama değeri |
| active | Aktiflik durumu |
| metadata | Ek kategori metadata |
| created_at / updated_at | Kayıt zaman bilgileri |
ERP kategori eşlemesi
ERP sisteminizde kendi kategori kimliğiniz ile BYNovax category_id arasında kalıcı eşleme tutmanız önerilir.
Yeni ürün gönderirken POST /products içindeki category_id alanına BYNovax kategori kimliğini yazmalısınız.
Örnek akış
1. GET /categories?limit=100
2. Kategori ağacını ERP'ye alın.
3. ERP category ↔ BYNovax category_id eşlemesi oluşturun.
4. Ürün oluştururken eşleşen BYNovax category_id gönderin.404 davranışı
GET /categories/{category} credential tenant kapsamında ilgili kategori bulunamazsa category_not_found benzeri 404 davranışı üretir.
Çalıştığını nasıl doğrularım?
- Kategori listesi 200 dönüyor.
- parent_id ilişkileriyle hiyerarşi kurulabiliyor.
- ERP kategori eşlemeleri saklanıyor.
- Ürün oluştururken BYNovax category_id kullanılıyor.