T-SOFT/Uygulama Geliştirme/Kapsamlar

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ı

KapsamNe verirHassas
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 silmeEvet
read_product_pricesBayi/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ştirmeEvet
read_merchandisingVitrin sıralamalarını, arama eşleştirmelerini ve kombinleri görüntüleme
write_merchandisingVitrin sıralamalarını, arama eşleştirmelerini ve kombinleri değiştirme
read_inventoryStok, depo ve stok birimlerini görüntüleme
write_inventoryStok 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_reviewsMüşteri adına ürün yorumu ekleme (yorum mağaza onayını bekler)Evet
read_product_alarmsMüşterilerin kurduğu fiyat ve stok alarmlarını görüntülemeEvet
write_product_alarmsFiyat ve stok alarmlarını bildirildi olarak kapatma ve silmeEvet
read_ordersSiparişleri ve sipariş durumlarını görüntüleme
write_ordersMevcut siparişleri düzenleme (durum değişikliği hariç)
write_order_statusSipariş durumunu değiştirmeEvet
create_ordersSipariş oluşturmaEvet
read_subscriptionsAbonelik siparişlerini görüntüleme
write_subscriptionsAbonelik siparişlerini iptal etme ve yeniden başlatma
read_financial_reportsÖdeme işlemlerini ve satış raporlarını görüntülemeEvet
read_fulfillmentsGönderi ve barkod bilgilerini görüntüleme
write_fulfillmentsGö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_customersMüşteri kayıtlarını ve adreslerini görüntüleme (kişisel veri)Evet
write_customersMüşteri kaydı oluşturma ve güncelleme (kişisel veri)Evet
read_customer_personal_dataSiparişlerdeki müşteri adını, e-postasını, telefonunu, adresini ve vergi numarasını görüntüleme (kişisel veri)Evet
read_customer_groupsMüşteri gruplarını, segmentlerini ve üye alanı tanımlarını görüntüleme
write_customer_groupsMüşteri gruplarını, segmentlerini ve üye alanı tanımlarını yönetme
read_customer_balancesMüşteri cari hareketlerini görüntülemeEvet
write_customer_balancesMüşteri cari hareketlerini yönetmeEvet
read_customer_messagesMüşteri mesajlarını görüntülemeEvet
write_customer_messagesMüşteri mesajlarını yanıtlama ve yönetmeEvet
read_cartsMüşteri sepetlerini görüntülemeEvet
read_discountsKampanyaları, kuponları ve hediye çeklerini görüntüleme
write_discountsKampanyaları, kuponları ve hediye çeklerini yönetme
read_contentSayfaları, blog yazılarını ve içerikleri görüntüleme
write_contentSayfaları, blog yazılarını ve içerikleri yönetme
read_themesTema, bölüm, blok ve menüleri görüntüleme
write_themesTema, bölüm, blok ve menüleri değiştirmeEvet
read_shippingKargo firmalarını, bölgeleri ve kargo ücretlerini görüntüleme
write_shippingKargo firmalarını, bölgeleri ve kargo ücretlerini yönetme
read_filesDosya yöneticisindeki dosyaları görüntüleme
write_filesDosya yükleme ve yönetme
read_tracking_codesEklediği izleme kodlarını görüntüleme
write_tracking_codesVitrine kendi izleme kodlarını ekleme ve yönetmeEvet
read_storeMağazanın para birimlerini, dillerini ve pazarlarını görüntüleme
read_store_settingsMağazanın iletişim bilgilerini görüntüleme
write_currenciesPara birimlerini ve döviz kurlarını güncellemeEvet
read_suppliersTedarikçileri görüntüleme
write_webhooksMağaza olayları için webhook tanımlama ve yönetmeEvet

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_customers ya da write_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.

Kaynaknull dönen alanlar
orderscustomerFirstName, customerLastName, customerEmail, customerPhone
order-addressesname, 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:

KapsamNe verir
storefront:readKatalog okuma (ürün, kategori, sayfa, ayar)
storefront:pricingİndirimli ve gruba özel fiyatları görme
storefront:accountMüşteri hesabı ve profil işlemleri
storefront:cartSepet oluşturma ve güncelleme
storefront:registerYeni müşteri kaydı
storefront:originSipariş/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ışı).