hikiehikieDeveloper Documentation
Endpoint'ler

Okuma işlemleri

Mağazanızı, ürünleri, siparişleri, satış raporunu ve indirimleri okuyun.

Tüm yollar https://api.hikie.space/v1 ile başlar. Mağaza, anahtarın ait olduğu mağazadır. Sayfalama ve tarih biçimleri için bkz. İstekler ve sınırlar.

Yöntem ve yolİzinSonuç
GET /storestore:readMağaza ve doğrulama durumu
GET /productsproducts:readDijital ürünler (eski tip dahil)
GET /products/{id}products:readAyrıntılarıyla tek ürün
GET /ordersorders:readSiparişler, yeniden eskiye
GET /orders/{id}orders:readTek sipariş
GET /reports/salesreports:readGün, hafta ya da ay bazında ciro ve iadeler
GET /discountsdiscount_codes:readTüm indirimler tek listede

Bu sürümde okuma endpoint'leri dijital ürünleri (type: "membership" ve eski tip type: "digital") kapsar. Fiziksel ürünler ürün endpoint'leriyle oluşturulup yönetilebilir, ama GET /products onları listelemez ve GET /products/{id} onlar için 404 döner. Siparişler her ürün türü için GET /orders'ta yer alır.

Müşterinin e-postası, telefonu, teslimat ve fatura adresleri, kart bilgileri ve ödeme sağlayıcı referansları hiçbir zaman döndürülmez.

Mağaza

GET /store

{
  "id": "6512ab3d9f1e4c0012a7bc45",
  "name": "Atölye Studio",
  "subdomain": "atolye",
  "address": "Kadıköy, İstanbul",
  "logo": "https://…/logo.png",
  "verification": "verified",
  "salesOpen": true,
  "storeClosed": false,
  "activeProducts": { "digital": 12, "membership": 3, "total": 15 }
}

verification değeri verified, pending, under_review ya da suspended olur. Ürünü yayına alabilmeniz ve ödeme alma linki oluşturabilmeniz için verified olmalıdır.

Ürünler

GET /products dijital ürünleri (eski tip dahil) yeniden eskiye döner. Yalnızca bir türü almak için type=digital ya da type=membership ekleyin.

{
  "items": [
    {
      "id": "66b1efd21c9a4e0021f3ab77",
      "type": "digital",
      "name": "Lansman rehberi",
      "slug": "lansman-rehberi",
      "status": "active",
      "price": 149.9,
      "compareAtPrice": null,
      "currency": "TRY",
      "images": ["https://…/rehber.jpg"],
      "createdAt": "2026-11-01T09:00:00.000Z",
      "updatedAt": "2026-11-01T09:30:00.000Z"
    }
  ],
  "total": 15,
  "page": 1,
  "limit": 20
}

status ürünün durumudur: eski tip dijital ürünlerde draft, active ya da inactive; membership türündekilerde draft ya da active. price güncel satış fiyatıdır; indirimli fiyatı olan bir dijital üründe indirimli fiyattır ve compareAtPrice asıl fiyattır. Teslimat içeriği, örneğin eski tip dijital ürünün sayfaları, hiçbir zaman döndürülmez.

GET /products/{id} aşağıdaki alanları ekler. Mağazanızda olmayan ürün 404 PRODUCT_NOT_FOUND döner.

TürEk alanlar
digitaldescription, categories, tags, variants (id, sku, price, compareAtPrice, isActive)
membershipdescription, headline, isFree, isVisible, features, faqs, pricing (type, price, discountedPrice, currency, subscriptionDuration, maxCharges)

type yalnızca ürünün ne olduğunu söyler. Alıcının nasıl ödeyeceği paymentType'tır; iki tür de bunu vatRate, shipmentAdressCollected, paymentPeriod, paymentPeriodCount, durationInCycleCount ve durationInCyclePeriod ile birlikte döner. Değerleri Ödeme tipleri bölümündeki gibidir.

paymentTypeÜrün türleripriceTekrarlayan alanlarpricing.type
one-offdigital, membershipSatış fiyatınullone-time
recurringmembershipHer tahsilatın tutarıDördü de dolurecurring
freemembershipnullnullfree

Eski tip dijital ürün her zaman one-off'tur. GET /products membership türündekiler için paymentType değerini listeler; eski tipte GET /products/{id} içinde görünür. Ürünün nasıl ödendiğini anlamak için paymentType'a bakın. pricing.type ürünün kendi diliyle aynı seçimdir; bu yüzden paymentType one-off derken o one-time yazar.

Siparişler

GET /orders şunları alır: page, limit, from, to (sipariş oluşturma zamanına göre) ve status: PENDING, PROCESSING, COMPLETED, CANCELLED, FAILED ya da REFUNDED.

curl 'https://api.hikie.space/v1/orders?from=2026-11-01&to=2026-11-07&status=COMPLETED' \
  -H "Authorization: Bearer hks_..."
{
  "id": "6720c1f0a9b1c2d3e4f5a6b7",
  "orderNumber": "17716204135268844HKS",
  "status": "COMPLETED",
  "isPaid": true,
  "paidAt": "2026-11-02T09:15:00.000Z",
  "createdAt": "2026-11-02T09:14:20.000Z",
  "cancelledAt": null,
  "currency": "TRY",
  "totalAmount": 149.9,
  "items": [
    { "productId": "66b1efd21c9a4e0021f3ab77", "name": "Lansman rehberi", "variant": null, "quantity": 1, "price": 149.9, "itemType": "product" }
  ],
  "discountCodes": [],
  "source": null
}

GET /orders/{id} siparişin id değerini ya da orderNumber değerini alır. Başka bir mağazanın siparişi 404 ORDER_NOT_FOUND döner.

Satış raporu

GET /reports/sales ödenmiş siparişleri döneme göre gruplar.

ParametreAnlamı
granularityday (varsayılan), week ya da month
from, toAralık. Varsayılan son 30 gün. En çok 1100 gün
{
  "granularity": "day",
  "from": "2026-10-31T21:00:00.000Z",
  "to": "2026-11-02T21:00:00.000Z",
  "rows": [
    { "period": "2026-11-01", "currency": "TRY", "revenue": 1249.5, "orders": 9, "refunds": { "count": 1, "amount": 149.9 } },
    { "period": "2026-11-02", "currency": "TRY", "revenue": 449.7, "orders": 3, "refunds": { "count": 0, "amount": 0 } }
  ],
  "totals": { "TRY": { "revenue": 1699.2, "orders": 12, "refunds": { "count": 1, "amount": 149.9 } } }
}
  • Dönemler Türkiye saatine göredir. Haftalar pazartesi başlayan ISO haftalarıdır ve 2026-W44 gibi yazılır; aylar 2026-11 gibi.
  • Satış, ödendiği ana göre tarihlenir.
  • İade edilmiş, iptal edilmiş ve başarısız siparişler revenue ve orders'a sayılmaz. İade edilen siparişler ayrıca refunds altında raporlanır.

İndirimler

GET /discounts otomatik indirimleri, ortak kodlu indirimleri ve tekil kodlu kampanyaları birlikte listeler. discount_codes:read izni ve onaylı geliştirici erişimi ister.

{
  "items": [
    {
      "id": "6720c1f0a9b1c2d3e4f5a6b7",
      "kind": "unique_codes",
      "name": "hikie Ekim Kampanyası",
      "code": null,
      "type": "percent",
      "percentOff": 20,
      "amountOff": null,
      "amountMinimum": 0,
      "currency": "TRY",
      "startsAt": null,
      "expiresAt": "2026-12-31T20:59:59.000Z",
      "isActive": true,
      "usageCount": 312,
      "maxUses": null,
      "createdAt": "2026-10-01T09:00:00.000Z"
    }
  ],
  "total": 1
}

kind değeri automatic, shared_code ya da unique_codes olur. type değeri percent, amount, free_shipping ya da free_product olur. code yalnızca ortak kodda doludur; tekil kodlu kampanyanın kodları /campaigns/{id}/codes altındadır (İndirimler). usageCount, indirimi kullanan ödenmiş siparişleri sayar.

Bu sayfada