Temel Ticaret APIcustomers:readorders:read

Müşteriler & İndirimler API

Farklı pazaryerlerinden ve e-ticaret sitenizden alışveriş yapan müşterilerinizi tekilleştirilmiş profiller halinde CRM sisteminize aktarın; kupon ve kampanya performanslarını analiz edin.

Kanallar Arası Müşteri Tekilleştirme

Aynı müşterinin hem Shopify sitenizden hem de Trendyol veya Hepsiburada mağazanızdan verdiği siparişler Armonika tarafından tek bir cus_... profili altında birleştirilir:

  • • Normalize edilmiş cep telefonu numarası ve gerçek e-posta adresi birincil eşleştirme anahtarıdır (pazaryerlerinin ürettiği geçici relay e-postalar kimlik birleştirmede yoksayılır).
  • • total_spent ve orders_count metriklerine iptal edilen (cancelled) ve iade edilen (returned) siparişler dahil edilmez.
İndirim Kaynağı Türleri (source)
coupon -> Müşterinin girdiği kupon kodu (örn. YAZ10)
seller -> Satıcı bütçeli otomatik sepette indirim
platform -> Pazaryeri bütçeli kampanya (ciroyu düşürmez)
GET/v1/customers

Müşterileri Listele

Basic base64(apiKey:secretKey)Kapsam: customers:readLimit: 120 istek / dk

Mağazanın tüm satış kanallarında tekilleştirilmiş müşteri profillerini, toplam sipariş sayılarını ve net harcama tutarlarını (iptal/iade hariç) imleçli olarak döndürür.

İstek Parametreleri

AlanKonumTipZorunlulukAçıklama
qQuerystringOpsiyonelAd soyad, e-posta veya telefon numarası ile müşteri araması.
channelQuerystringOpsiyonelBelirli bir kanaldan alışveriş yapmış müşterileri filtrele.
cursorQuerystringOpsiyonelSayfalama imleci.
limitQueryinteger (1–100)Vars: 50Sayfa boyutu.
GET/v1/customers
curl -X GET "https://api.armonika.app/v1/customers?limit=25" \
-u "arm_9f8a7b6c5d4e:arm_sec_1a2b3c4d5e6f7g8h9i0j"
Yanıt (Response)
HTTP/1.1 200 OK
{
"success": true,
"data": [
{
"id": "cus_01JB8W4X9Z1A3C5E7G9",
"full_name": "Zeynep Kaya",
"email": "zeynep.kaya@ornek.com",
"phone": "+905551234567",
"city": "İstanbul",
"orders_count": 6,
"total_spent": 8420.5,
"currency": "TRY",
"channels": ["shopify", "trendyol"],
"last_order_at": "2026-11-17T08:15:00Z"
}
],
"pagination": { "limit": 25, "has_more": false, "next_cursor": null }
}
GET/v1/customers/{customer_id}

Tekil Müşteri Detayını ve Kanal Kırılımını Getir

Basic base64(apiKey:secretKey)Kapsam: customers:readLimit: 120 istek / dk

Müşterinin iletişim bilgilerini, kanal bazında sipariş/harcama dağılımını, son siparişlerini ve kullandığı kupon/indirim kodlarını döndürür.

İstek Parametreleri

AlanKonumTipZorunlulukAçıklama
customer_idPathstringZorunluArmonika müşteri kimliği (örn. cus_01JB8W4X9Z1A3C5E7G9).
GET/v1/customers/{customer_id}
curl -X GET "https://api.armonika.app/v1/customers/cus_01JB8W4X9Z1A3C5E7G9" \
-u "arm_9f8a7b6c5d4e:arm_sec_1a2b3c4d5e6f7g8h9i0j"
Yanıt (Response)
HTTP/1.1 200 OK
{
"success": true,
"data": {
"id": "cus_01JB8W4X9Z1A3C5E7G9",
"full_name": "Zeynep Kaya",
"email": "zeynep.kaya@ornek.com",
"phone": "+905551234567",
"city": "İstanbul",
"district": "Kadıköy",
"orders_count": 6,
"total_spent": 8420.5,
"channel_breakdown": [
{ "channel": "shopify", "orders_count": 4, "total_spent": 5920.5 },
{ "channel": "trendyol", "orders_count": 2, "total_spent": 2500.0 }
],
"redeemed_coupons": ["YAZ10", "HOSGELDIN15"]
}
}
GET/v1/discounts

Kampanya ve İndirim Kırılımlarını Listele

Basic base64(apiKey:secretKey)Kapsam: orders:readLimit: 120 istek / dk

Siparişlerde uygulanan kupon kodlarını, satıcı bütçeli kampanyaları (seller) ve pazaryerinin kendi bütçesinden karşıladığı indirimleri (platform) kullanım adedi ve toplam tutarlarıyla döndürür.

İstek Parametreleri

AlanKonumTipZorunlulukAçıklama
sourceQuery'seller' | 'platform' | 'coupon'Opsiyonelİndirim kaynağı filtresi.
channelQuerystringOpsiyonelSatış kanalı filtresi.
start_dateQueryISO 8601 datetimeOpsiyonelBaşlangıç tarihi.
end_dateQueryISO 8601 datetimeOpsiyonelBitiş tarihi.
GET/v1/discounts
curl -X GET "https://api.armonika.app/v1/discounts?source=coupon" \
-u "arm_9f8a7b6c5d4e:arm_sec_1a2b3c4d5e6f7g8h9i0j"
Yanıt (Response)
HTTP/1.1 200 OK
{
"success": true,
"data": [
{
"code": "YAZ10",
"source": "coupon",
"channel": "shopify",
"used_count": 48,
"total_discount_amount": 7240.0,
"affects_seller_revenue": true
}
]
}