Kapsamlar
Uygulamanız yalnız kayıtta istediği ve mağaza sahibinin onayladığı kapsamlarla Admin API'ye erişir. Onaylanmamış bir kapsamın ucunu çağırırsanız 403 alırsınız.
İstediğiniz her kapsam, onay ekranında mağaza sahibine açıklamasıyla gösterilir. Hassas kapsamlar (kişisel veri, fiyat, sipariş oluşturma, takip kodu, webhook gibi) uyarıyla işaretlenir ve kurulum oranını düşürür; yalnız gerçekten kullandıklarınızı isteyin. write_ kapsamları ilgili read_ erişimini de içerir.
Admin API kapsamları
| Kapsam | Ne verir | Hassas |
|---|---|---|
read_products | Ürünleri, varyantları, görselleri, markaları, kategorileri ve liste fiyatlarını görüntüleme | |
write_products | Ürün oluşturma, güncelleme ve yayından kaldırma (silme ve fiyat değişikliği hariç) | |
delete_products | Ürün silme | Evet |
read_product_prices | Bayi/grup fiyatlarını, miktar indirimlerini ve bölge fiyatlarını görüntüleme | |
write_product_prices | Ürün fiyatlarını, bayi/grup fiyatlarını ve miktar indirimlerini değiştirme | Evet |
read_merchandising | Vitrin sıralamalarını, arama eşleştirmelerini ve kombinleri görüntüleme | |
write_merchandising | Vitrin sıralamalarını, arama eşleştirmelerini ve kombinleri değiştirme | |
read_inventory | Stok, depo ve stok birimlerini görüntüleme | |
write_inventory | Stok miktarlarını, depoları ve stok birimlerini güncelleme | |
read_reviews | Ürün yorumlarını görüntüleme | |
write_reviews | Ürün yorumlarını yönetme | |
create_reviews | Müşteri adına ürün yorumu ekleme (yorum mağaza onayını bekler) | Evet |
read_product_alarms | Müşterilerin kurduğu fiyat ve stok alarmlarını görüntüleme | Evet |
write_product_alarms | Fiyat ve stok alarmlarını bildirildi olarak kapatma ve silme | Evet |
read_orders | Siparişleri ve sipariş durumlarını görüntüleme | |
write_orders | Mevcut siparişleri düzenleme (durum değişikliği hariç) | |
write_order_status | Sipariş durumunu değiştirme | Evet |
create_orders | Sipariş oluşturma | Evet |
read_subscriptions | Abonelik siparişlerini görüntüleme | |
write_subscriptions | Abonelik siparişlerini iptal etme ve yeniden başlatma | |
read_financial_reports | Ödeme işlemlerini ve satış raporlarını görüntüleme | Evet |
read_fulfillments | Gönderi ve barkod bilgilerini görüntüleme | |
write_fulfillments | Gönderi oluşturma ve güncelleme | |
read_returns | İade taleplerini ve para iadelerini görüntüleme | |
write_returns | İade taleplerini ve para iadelerini yönetme | |
read_customers | Müşteri kayıtlarını ve adreslerini görüntüleme (kişisel veri) | Evet |
write_customers | Müşteri kaydı oluşturma ve güncelleme (kişisel veri) | Evet |
read_customer_personal_data | Siparişlerdeki müşteri adını, e-postasını, telefonunu, adresini ve vergi numarasını görüntüleme (kişisel veri) | Evet |
read_customer_groups | Müşteri gruplarını, segmentlerini ve üye alanı tanımlarını görüntüleme | |
write_customer_groups | Müşteri gruplarını, segmentlerini ve üye alanı tanımlarını yönetme | |
read_customer_balances | Müşteri cari hareketlerini görüntüleme | Evet |
write_customer_balances | Müşteri cari hareketlerini yönetme | Evet |
read_customer_messages | Müşteri mesajlarını görüntüleme | Evet |
write_customer_messages | Müşteri mesajlarını yanıtlama ve yönetme | Evet |
read_carts | Müşteri sepetlerini görüntüleme | Evet |
read_discounts | Kampanyaları, kuponları ve hediye çeklerini görüntüleme | |
write_discounts | Kampanyaları, kuponları ve hediye çeklerini yönetme | |
read_content | Sayfaları, blog yazılarını ve içerikleri görüntüleme | |
write_content | Sayfaları, blog yazılarını ve içerikleri yönetme | |
read_themes | Tema, bölüm, blok ve menüleri görüntüleme | |
write_themes | Tema, bölüm, blok ve menüleri değiştirme | Evet |
read_shipping | Kargo firmalarını, bölgeleri ve kargo ücretlerini görüntüleme | |
write_shipping | Kargo firmalarını, bölgeleri ve kargo ücretlerini yönetme | |
read_files | Dosya yöneticisindeki dosyaları görüntüleme | |
write_files | Dosya yükleme ve yönetme | |
read_tracking_codes | Eklediği izleme kodlarını görüntüleme | |
write_tracking_codes | Vitrine kendi izleme kodlarını ekleme ve yönetme | Evet |
read_store | Mağazanın para birimlerini, dillerini ve pazarlarını görüntüleme | |
read_store_settings | Mağazanın iletişim bilgilerini görüntüleme | |
write_currencies | Para birimlerini ve döviz kurlarını güncelleme | Evet |
read_suppliers | Tedarikçileri görüntüleme | |
write_webhooks | Mağaza olayları için webhook tanımlama ve yönetme | Evet |
Müşteri kişisel verisi
read_orders siparişi verir, siparişi veren kişiyi tanıtan alanları vermez. Müşterinin adı, e-postası, telefonu, adresi ve vergi numarası için uygulamanız şu kapsamlardan birine sahip olmalıdır:
read_customer_personal_data: yalnız siparişteki kişisel veri için; müşteri kayıtlarını listelemez.read_customersya dawrite_customers: müşteri kayıtlarıyla birlikte siparişteki kişisel veriyi de açar.
Bu kapsamlardan biri yoksa aşağıdaki alanlar yanıtta kalır ama null döner; istek 200 ile başarılı olur. Uygulamanız bu alanların boş gelebileceğini hesaba katmalıdır.
| Kaynak | null dönen alanlar |
|---|---|
orders | customerFirstName, customerLastName, customerEmail, customerPhone |
order-addresses | name, surname, address, mobilePhone, homePhone, otherPhone, taxNumber, zipCode, coordinateX, coordinateY |
customers (?include=customer ya da orders/{id}/customer ile) | firstName, lastName, email, mobilePhone, phone |
İl, ilçe ve ülke gibi bölge bilgisi her zaman gelir. Kargo etiketi ya da fatura kesen uygulamalar read_customer_personal_data istemelidir; analiz ve raporlama yapanlar çoğu zaman read_orders ile yetinir.
Bu kural yalnız mağazaya kurulu uygulamalar için geçerlidir. Mağaza paneli etkilenmez.
Vitrin kapsamları
Vitrin uygulamaları (mobil uygulama, headless vitrin) Storefront API için şu kapsamları isteyebilir:
| Kapsam | Ne verir |
|---|---|
storefront:read | Katalog okuma (ürün, kategori, sayfa, ayar) |
storefront:pricing | İndirimli ve gruba özel fiyatları görme |
storefront:account | Müşteri hesabı ve profil işlemleri |
storefront:cart | Sepet oluşturma ve güncelleme |
storefront:register | Yeni müşteri kaydı |
storefront:origin | Sipariş/işlem kaynağı bilgisi |
Kapsam değiştirme
Yeni bir kapsam istemek için kaydınızı güncelletin. Mağaza sahibi Uygulamalarım ekranında İzinleri onayla bağlantısını görür; onayladığında size yeni bir kurulum kodu gelir (OAuth Akışı).