geliştirici belgeleri

Webhook konuları

Bir uygulamanın abone olabileceği konular, her birinin gerektirdiği izin ve zorunlu KVKK konuları.

Bu sayfa koddan üretilir. Uygulama konulara webhooks.subscriptions[].topics anahtarında abone olur; bir konu, izin sütunundaki izni gerektirir.

Konu Ne zaman gelir Gereken izin
app/scopes_update Uygulamanın verilmiş izinleri değişti: mağaza yeni sürümün izinlerini onayladı veya bir sürüm geçişi izin düşürdü. —
app/uninstalled Mağaza uygulamayı kaldırdı. —
app_subscriptions/update Uygulamanın bir ücretlendirmesinin durumu değişti; yalnızca o ücretlendirmenin uygulaması alır. —
checkouts/update Ödeme adımındaki bir alışveriş değişti. read_orders
customers/create Bir müşteri oluşturuldu: yönetim panelinden, CSV içe aktarımından, ilk siparişinde, hesabına ilk girişinde veya bülten formundan. Gövde, uygulamanın müşteri verisi düzeyine göre süzülür; düzey en az 1 olmalıdır. read_customers
customers/delete Bir müşteri silindi (KVKK silme talebiyle silinenler dahil); gövdede yalnızca id bulunur. read_customers
customers/marketing_consent_update Bir müşterinin pazarlama izni nereden olursa olsun (ödeme sayfası, müşteri hesabı, abonelikten çık bağlantısı, bülten formu, yönetim paneli, CSV içe aktarma, bir uygulama, İYS) verildi veya geri alındı, ya da izinli bir müşteri verilerinin silinmesini istedi (state unsubscribed, source erasure_request; silme talebinden sonra verilen izin de böyle gelir) veya mağaza onu sildi (state unsubscribed, source customer_deleted). Gövde customer_id, channel, state, consent_updated_at ve source'tur; uygulama geri alınan müşteriyi hemen listesinden çıkarmalıdır. read_marketing_audience veya write_marketing_consent izniyle ve müşteri verisi düzeyi 2 ile alınır. read_marketing_audience
customers/update Bir müşterinin iletişim bilgileri, adresi, etiketleri, pazarlama izni, sipariş sayısı veya toplam harcaması değişti. Gövde, uygulamanın müşteri verisi düzeyine göre süzülür. read_customers
draft_orders/create Bir taslak sipariş oluşturuldu. read_draft_orders
draft_orders/delete Bir taslak sipariş silindi; gövdede yalnızca id bulunur. read_draft_orders
draft_orders/update Bir taslak sipariş kaydedildi, faturası gönderildi veya tamamlandı. read_draft_orders
fulfillments/create Bir sipariş için gönderim oluşturuldu. read_orders
gift_cards/create Bir hediye kartı oluşturuldu. Gövdede kodun yalnızca son dört karakteri bulunur. read_gift_cards
gift_cards/update Bir hediye kartının bakiyesi, notu, son kullanma tarihi, müşterisi veya kullanıma kapalı olması değişti. read_gift_cards
inventory/low Bir varyantın stoğu düşük stok eşiğinin altına indi. read_products
inventory_levels/update Bir konumdaki stok adedi değişti; bir işlemin değiştirdiği her stok kaydı için bir kez gelir. read_inventory
iys/consent Mağazanın kaydettiği pazarlama izinleri ve retleri, İYS'ye işlenmek üzere; yalnızca sms_commercial sürümündeki seçili SMS sağlayıcı uygulamaya gider. Uygulama her olayın sonucunu yanıtta döner: recorded, rejected veya retry. write_sms
orders/cancelled Bir sipariş iptal edildi. read_orders
orders/create Bir sipariş oluşturuldu. read_orders
orders/paid Bir siparişin ödemesi tamamlandı. read_orders
orders/updated Bir sipariş değişti: durumu, satırları, notu, etiketleri veya adresleri. read_orders
products/create Bir ürün eklendi. read_products
products/delete Bir ürün silindi. read_products
products/update Bir ürün değişti. read_products
refunds/create Bir iade yapıldı. read_orders
refunds/update Uygulamanın istediği bir iade başarısız oldu, örneğin ödeme uygulaması kart iadesini reddetti. Başarılı iade refunds/create ile gelir. read_orders
shop/update Mağazanın planı, adı, iletişim bilgileri, dili, para birimi, logosu veya ana alan adı (gövdedeki primary_url) değişti. Gövde /api/v1/shop çıktısıdır, store_id ile. —
sms/send Mağazanın SMS sağlayıcısı olarak seçilen uygulamaya gönderilecek bir SMS: alıcı telefonu ve metin. Uygulama sonucu POST /api/v1/sms/{id}/status ile bildirir. write_sms

Zorunlu KVKK konuları

Bu konulara abone olunmaz: her uygulama privacy bloğundaki adreslerde bunları yanıtlamak zorundadır.

Konu Ne zaman gelir
customers/data_request Bir müşteri, uygulamanın kendisi hakkında tuttuğu verileri istedi. privacy.customers_data_request_url adresine gelir.
customers/redact Bir müşterinin verileri silinmeli. privacy.customers_redact_url adresine gelir.
store/redact Uygulamayı kaldıran mağazanın verileri silinmeli. privacy.store_redact_url adresine gelir.