API Reference

Muhasebe Önemli Bilgiler

Servis, ödeme ve faturaları listelemenize olanak tanır.

👍

Önemli Bilgiler

Bu dokümanda yer alan endpoint url'leri test ortamına aittir. Dokumanda sayfasında test ortam endpointleri test edilebilir. Canlı ortam url'leri endpoint içinde "-sit" ifadesi kaldırılarak oluşturabilirsiniz. Canlı ortam endpoint'ine canlı ortam için verilen User/Password ile istek gönderilebilir.

📘

Hepsiburada API Authentication Bilgilendirmesi

Mevcuttaki tüm servislerimizin authentication yapısında değişiklik yapılmıştır. Sizlerden servislerimizdeki bu değişikliğin hızla yapılması noktasında desteğinizi rica ederiz.

Entegratöre Servis Anahtarı Ekleme/Görüntüleme işlemleri için hazırladığımız sayfamızı inceleyebilirsiniz.

Finansal kayıtlarınız sipariş teslim edildikten sonra oluşmaktadır.

  • Merchantid = Zorunludur, Her satıcının unique bir tanımlayıcısıdır.
  • transactionTypes= Opsiyoneldir, kayıt tiplerini belirtir. Bu parametre verilmediğinde tüm kayıt tipleri listelenecektir. Spesifik tipler bakılmak istenirse sorgulanacak tipler virgülle ayrılarak yazılabilir. Örnek; transactiontypes=Commission, Payment
  • recordDateStart - recordDateEnd
  • dueDateStart - dueDateEnd
  • orderDateStart - orderDateEnd
  • paymentDateStart – paymentDateEnd
  • 4 tarih aralığı parametresinden biri girilmek zorundadır. Bir tanesi girildikten sonra kalanlar opsiyonel eklenebilir. orderNumber, packageNumber, sku, invoiceNumber arametrelerinden en az biri verilirse tarih parametreleri zorunlu olmayacaktır.
  • offset/limit = Girişi zorunludur. Offset, kaçıncı kayıttan itibaren gösterileceğini verir. Limit, servisten kaç tane kayıt döneceğini belirler. Limit en fazla 100 olabilir.
  • Örnek; Kayıtlar yüzer yüzer çekildiğinde yani limiti 100 belirlendiğinde, 3. sayfayı göstermek için offset=200&limit=100 girilecektir.
  • status = Opsiyoneldir. İlgili kaydın ödeme statüsünü belirtir.
  • Örnek; status=Paid
  • Paid : Ödenenler
  • WillBePaid : Henüz ödenmeyenleri belirtir.
  • orderNumber = Opsiyoneldir. Sipariş numarası olarak geçer.
  • Örnek; orderNumber=0019531668
  • packageNumber = Opsiyoneldir. Paket numarası
  • Örnek; packageNumber=0019531668
  • sku = Opsiyoneldir. Ürün Hepsiburada numarasıdır.
  • Örnek; sku=HBV0000058C3H
  • ReferenceDocument = Opsiyoneldir. Kayıt ya da Fatura numarasına karşılık gelir.
  • Örnek; ReferenceDocument=HD12018000104453
  • transactionTypes parametresi “InvoiceTransactions“ olarak beslendiğinde yalnızca faturalar için listeleme yapılacaktır.
  • IsInvoice : Bu alan ilgili kaydın fatura mı değil mi bilgisini döner. True döndüğü durumda kaydın fatura olduğu anlaşılır. False döndüğü durumda kaydın fatura tipinde olmadığı anlaşılır.
  • IsIncome : Bu alan ilgili kaydın gelir mi gider mi bilgisini döner. True döndüğü durumda geliri ifade eder, false döndüğü durumda gideri ifade eder.
currencyCodeAçıklama
949TRY
840USD

Birden fazla currency ile sonuç dönmesi durumunda 409 uyarısı ve uyarı mesajı olarak aşagıdaki response dönecektir;

ErrorMessage: More than one currencies exist in the results. MerchantId : {merchant.SapId}. Merchant Name : {merchant.Name}

ExceptionCode: MoreThanOneCurrenciesExistInTheResults

Kayıt Tipi Bilgileri

Transaction Type Açıklama Detay Bilgi
Payment Sipariş tutarı Siparişe ait ürünün satış tutarını ifade etmektedir.
DeliveryProcessingFee İşlem Bedeli Her bir teslimat başına alınan işlem bedelidir.
DeliveryProcessingFeeRefund İşlem Bedeli İadesi Her bir teslimat başına alınan işlem bedelinin iadesidir.
Return İade tutarı İade edilen sipariş tutarlarını ifade etmektedir.
Commission Komisyon tutarı Siparişe ait komisyon faturalarını ifade etmektedir.
CommissionInvoiceRefund Komisyon iadesi Hepsiburada'ya düzenlediğiniz komisyon iade faturaları ile iadesi onaylanan siparişlerinizde, mağazanıza geri ödenen komisyon tutarlarını gösterir.
CommissionRefund Komisyon iade tutarı Siparişe ait iade edilen komisyon faturalarını ifade etmektedir.
ShipmentCostSharingExpense Kargo katkı payı gideri Hepsiburada anlaşmalı kargo desi/fiyat tablosuna ve kampanya süreçlerine göre düzenlenen kargo faturalarıdır.
ShipmentCostSharingIncome Kargo katkı payı iadesi Siparişe ait paketler üzerinden uygulanan kargo giderleri için düzenlenen iade faturalarıdır.
ProcessingFeeExpense Hizmet bedeli Siparişe ait ürünler üzerinden uygulanan hizmet bedeli tutarıdır.
ProcessingFeeExpenseRefund Hizmet bedeli iadesi Hizmet bedeli iade faturalarıdır.
CustomerSatisfaction Müşteri memnuniyeti yansıtma Tedarik gecikmesi ve sipariş iptallerinden doğan işlemler için düzenlenen faturalardır.
CustomerSatisfactionRefund Müşteri memnuniyeti yansıtma iadesi Sipariş gecikme ve iptal ücretlendirmeleri karşılığında düzenlenen iade faturalarıdır.
LineItemTransferExpense Sipariş transfer gideri Tedarik edilemeyen ve iptali sağlanan siparişler için kesilen "sipariş kaydırma" tutarlarını ifade etmektedir.
LineItemTransferIncome Sipariş transfer geliri Sipariş transfer gideri faturaları karşılığında düzenlenen iade faturalarıdır.
CampaignDiscount Kampanya indirimleri Hepsiburada\'ya düzenlediğiniz kampanya faturaları ile Hepsiburada\'nın siparişlerinizde karşıladığı, komisyonunuzdan düşen indirim tutarlarını gösterir.
CampaignDiscountRefund Kampanya indirimleri iadesi Siparişe ait iade edilen kampanya indirimleri faturalarını ifade etmektedir.
RevenueExpense Ciro gideri Anlaşmalı ciro gideri faturalarını ifade etmektedir.
RevenueIncome Ciro geliri Anlaşmalı ciro geliri faturalarını ifade etmektedir.
CargoMargin Kargo marj Siparişe ait paketler üzerinden uygulanan kargo giderleri için düzenlenen iade faturalarıdır.
CargoCompensationIncomeRefund Kargo tazmin geliri iadesi Sipariş tazminleri için kestiğiniz faturaları ifade eder.
MpScrapIncome Hurda geliri Müşteri memnuniyeti adına iadesi onaylanan siparişleriniz için Hepsiburada\'ya düzenlediğiniz faturalardır.
RefusedInvoiceExpenseRefund Reddedilen faturalar Hepsiburada\'ya düzenlenen ancak onaylanmayan faturalardır.
RefusedInvoiceExpense Reddedilen fatura bedeli Hepsiburada\'ya düzenlenen ancak onaylanmayan faturaları ifade etmektedir.
Deposit Depozito tutarı Depozito faturalarını ifade etmektedir.
AdSharingExpense Reklam katılım gideri Reklam katılım bedeli faturalarıdır.
AdSharingExpenseRefund Reklam katılım gideri iadesi Reklam katılım bedeli iade faturalarıdır.
DropShipmentCostSharingExpense Drop kargo katkı payı gideri Hepsiburada anlaşmalı kargo desi/fiyat tablosuna ve kampanya süreçlerine göre düzenlenen kargo faturalarıdır.
DropShipmentCostSharingIncome Drop kargo katkı payı geliri Siparişe ait paketler üzerinden uygulanan kargo giderleri için düzenlenen iade faturalarıdır.
Chargeout Masraf yansıtma tutarı Masraf yansıtma faturalarını ifade etmektedir.
CargoCompensationSellerSatisfactionIncome Kargo tazmin satıcı memnuniyet geliri Satıcı memnuniyeti sebebiyle tarafınızdan alınan iade tazmin faturalarını ifade eder.
MarketingExpense Pazarlama bedeli Pazarlama/reklam faturalarını ifade etmektedir.
MarketingExpenseRefund Pazarlama bedeli iadesi İade edilen pazarlama faturalarını ifade etmektedir.
StudioExpense Stüdyo kullanım bedeli Stüdyo kullanım bedeli faturalarıdır.
PriceDifferenceExpense Fiyat farkı bedeli Maliyetlerde meydana gelen değişikliklerin yansıtıldığı faturaları ifade eder.
PriceDifferenceRefund Fiyat farkı iadesi Maliyetlerde meydana gelen değişikliklerin firma tarafından HB\'ye iletilmesini ifade etmektedir.
LateInterestExpense Vade farkı gideri Vade farkı sebebiyle kesilen faturaladır.
CargoCostRefund Kargo iade Kargo tutar iadesi sebebiyle düzenlediğiniz faturalardır.
RoadAssistanceExpenseRefund Yol yardım iadesi İade edilen yol yardım faturalarını ifade etmektedir.
RoadAssistanceExpense Yol yardım bedeli Yol yardım faturalarını ifade etmektedir.
SponsorshipFee Sponsorluk bedeli Sponsorluk faturalarını ifade etmektedir.
OverseasCommissionRefund Yurtdışı komisyon iadesi Yurtdışı siparişe ait iade edilen komisyon faturalarını ifade etmektedir.
MpScrapExpense Hurda gideri Sipariş özelinde HB\'nın düzenlemiş olduğu memnuniyet faturalarını ifade etmektedir.
MpCompensationIncome MP operasyon departmanı tazmin geliri Kampanya döneminde düzenlenen Hizmet Bedeli faturasının iadesidir.
CargoCompensationExpenseRefund Kargo tazmin gideri iadesi Sipariş tazminleri için düzenlediğiniz faturaların iadesidir.
VAT KDV Katma değer vergisi faturalarını ifade etmektedir.
BalanceCorrection Düzeltme kaydı Muhasebe/Finans tarafından ekstre üzerinde uygulanan ters kayıt işlemlerini ifade etmektedir.
SfsInterest TFS vade farkı TFS işlemi sonrası firmaya yansıtılan tfs gideri
ProductsReportedByService MP servis raporlu ürünler MP Servis Raporlu Ürünler
FacebookAdExpense MP Facebook reklam gideri Facebook reklam katılım bedeli faturalarıdır.
CargoLimitExcessCompensationIncome Kargo limit aşımı tazmin geliri Sipariş tazminleri için kestiğiniz faturaları ifade eder.
OrderBasedTransactions Sipariş bazlı kayıtlar Sipariş bazlı kayıtlarınızı listeler
ContractualOrSpecialCaseTransactions Sözleşmeye bağlı / Özel durum kayıtlar Sözleşmeye bağlı / Özel durum kayıtlarınızı listeler
CommissionSettlementTransactions Komisyon mahsuplaşma kayıtları Komisyon mahsup içerisinde yer alan tüm kayıtlarınızı listeler(Mahsup içerisindeki komisyon, kampanya indirimleri gibi.)
InvoiceTransactions Faturalar Fatura tipindeki kayıtlarınızı listeler
IncomeTransactions Tüm gelir kayıtları Gelir tipindeki tüm kayıtlarınızı listeler
ExpenseTransactions Tüm gider kayıtları Gider tipindeki tüm kayıtlarınızı listeler
AdBalanceTopUpFromAllowance Reklam Bakiye Yüklemesi Hak edişinizden reklam bakiyesi olarak yüklediğiniz tutarı ifade etmektedir. Kullanım detayları için Merchant paneldeki Reklam sayfasını ziyaret edebilirsiniz.
AdBalanceTopUpFromAllowanceRefund Reklam bakiye iadesi Reklam bakiyenizden hak edişinize iade edilen tutarı ifade etmektedir.
MarketingSupportParticipation Pazarlama Destek Katılım Fenomen reklamlarından gelen siparişleriniz için kesilen katılım tutarınızı ifade etmektedir.

Performans Servisi

Servis, sipariş ve ürün detayı bazında finansal performansın listelenmesine olanak tanır. Finansal kayıtlarınız sipariş teslim edildikten sonra oluşmaktadır.

  • Merchantid = Zorunludur, Her satıcının unique bir tanımlayıcısıdır.
  • orderDateStart - orderDateEnd
    dueDateStart – dueDateEnd
    2 tarih aralığı parametresinden biri girilmek zorundadır. Bir tanesi girildikten sonra kalanlar opsiyonel eklenebilir. orderNumber, Sku parametrelerinden en az biri verilirse tarih parametreleri zorunlu olmayacaktır.
    Örnek format;
    orderDateStart=2021-08-01& orderDateEnd=2021-08-31
    dueDateStart=2021-08-01& dueDateEnd=2021-08-31
  • offset/limit = Girişi zorunludur. Offset, kaçıncı kayıttan itibaren gösterileceğini verir. Limit, servisten kaç tane kayıt döneceğini belirler. Limit en fazla 100 olabilir.
    Örnek; Kayıtlar yüzer yüzer çekildiğinde yani limiti 100 belirlendiğinde, 3. sayfayı göstermek için offset=200&limit=100 girilecektir.
  • orderNumber = Opsiyoneldir. Sipariş numarası olarak geçer.
    Örnek; orderNumber=0019531668
  • sku = Opsiyoneldir. Ürün Hepsiburada numarasıdır.
    Örnek; sku=HBV0000058C3H
    • İstek içerisinde orderNumber, sku parametreleri verilerek çağrım yapılırsa sipariş numarası ve ürün numarasına ait net kazanç, gelir, gider performansı gözlemlenebilir.
    • Döviz Cinsi Kodları; currencyCode alanında dönen bilgidir.
      currencyCodeAçıklama
      949TRY
      840USD

    **Birden fazla currency ile sonuç dönmesi durumunda 409 uyarısı ve uyarı mesajı olarak aşagıdaki response dönecektir;
    ErrorMessage: More than one currencies exist in the results. MerchantId : {merchant.SapId}. Merchant Name : {merchant.Name}
    ExceptionCode: MoreThanOneCurrenciesExistInTheResults**

    Kayıt Tipi Bilgileri

    Transaction Type Açıklama Detay Bilgi
    Payment Sipariş tutarı Siparişe ait ürünün satış tutarını ifade etmektedir.
    DeliveryProcessingFee İşlem Bedeli Her bir teslimat başına alınan işlem bedelidir.
    DeliveryProcessingFeeRefund İşlem Bedeli İadesi Her bir teslimat başına alınan işlem bedelinin iadesidir.
    Return İade tutarı İade edilen sipariş tutarlarını ifade etmektedir.
    Commission Komisyon tutarı Siparişe ait komisyon faturalarını ifade etmektedir.
    CommissionInvoiceRefund Komisyon iadesi Hepsiburada\'ya düzenlediğiniz komisyon iade faturaları ile iadesi onaylanan siparişlerinizde, mağazanıza geri ödenen komisyon tutarlarını gösterir.
    CommissionRefund Komisyon iade tutarı Siparişe ait iade edilen komisyon faturalarını ifade etmektedir.
    ShipmentCostSharingExpense Kargo katkı payı gideri Hepsiburada anlaşmalı kargo desi/fiyat tablosuna ve kampanya süreçlerine göre düzenlenen kargo faturalarıdır.
    ShipmentCostSharingIncome Kargo katkı payı iadesi Siparişe ait paketler üzerinden uygulanan kargo giderleri için düzenlenen iade faturalarıdır.
    ProcessingFeeExpense Hizmet bedeli Siparişe ait ürünler üzerinden uygulanan hizmet bedeli tutarıdır.
    ProcessingFeeExpenseRefund Hizmet bedeli iadesi Hizmet bedeli iade faturalarıdır.
    CustomerSatisfaction Müşteri memnuniyeti yansıtma Tedarik gecikmesi ve sipariş iptallerinden doğan işlemler için düzenlenen faturalardır.
    CustomerSatisfactionRefund Müşteri memnuniyeti yansıtma iadesi Sipariş gecikme ve iptal ücretlendirmeleri karşılığında düzenlenen iade faturalarıdır.
    LineItemTransferExpense Sipariş transfer gideri Tedarik edilemeyen ve iptali sağlanan siparişler için kesilen "sipariş kaydırma" tutarlarını ifade etmektedir.
    LineItemTransferIncome Sipariş transfer geliri Sipariş transfer gideri faturaları karşılığında düzenlenen iade faturalarıdır.
    CampaignDiscount Kampanya indirimleri Hepsiburada\'ya düzenlediğiniz kampanya faturaları ile Hepsiburada\'nın siparişlerinizde karşıladığı, komisyonunuzdan düşen indirim tutarlarını gösterir.
    CampaignDiscountRefund Kampanya indirimleri iadesi Siparişe ait iade edilen kampanya indirimleri faturalarını ifade etmektedir.
    RevenueExpense Ciro gideri Anlaşmalı ciro gideri faturalarını ifade etmektedir.
    RevenueIncome Ciro geliri Anlaşmalı ciro geliri faturalarını ifade etmektedir.
    CargoMargin Kargo marj Siparişe ait paketler üzerinden uygulanan kargo giderleri için düzenlenen iade faturalarıdır.
    CargoCompensationIncomeRefund Kargo tazmin geliri iadesi Sipariş tazminleri için kestiğiniz faturaları ifade eder.
    MpScrapIncome Hurda geliri Müşteri memnuniyeti adına iadesi onaylanan siparişleriniz için Hepsiburada\'ya düzenlediğiniz faturalardır.
    RefusedInvoiceExpenseRefund Reddedilen faturalar Hepsiburada\'ya düzenlenen ancak onaylanmayan faturalardır.
    RefusedInvoiceExpense Reddedilen fatura bedeli Hepsiburada\'ya düzenlenen ancak onaylanmayan faturaları ifade etmektedir.
    Deposit Depozito tutarı Depozito faturalarını ifade etmektedir.
    AdSharingExpense Reklam katılım gideri Reklam katılım bedeli faturalarıdır.
    AdSharingExpenseRefund Reklam katılım gideri iadesi Reklam katılım bedeli iade faturalarıdır.
    DropShipmentCostSharingExpense Drop kargo katkı payı gideri Hepsiburada anlaşmalı kargo desi/fiyat tablosuna ve kampanya süreçlerine göre düzenlenen kargo faturalarıdır.
    DropShipmentCostSharingIncome Drop kargo katkı payı geliri Siparişe ait paketler üzerinden uygulanan kargo giderleri için düzenlenen iade faturalarıdır.
    Chargeout Masraf yansıtma tutarı Masraf yansıtma faturalarını ifade etmektedir.
    CargoCompensationSellerSatisfactionIncome Kargo tazmin satıcı memnuniyet geliri Satıcı memnuniyeti sebebiyle tarafınızdan alınan iade tazmin faturalarını ifade eder.
    MarketingExpense Pazarlama bedeli Pazarlama/reklam faturalarını ifade etmektedir.
    MarketingExpenseRefund Pazarlama bedeli iadesi İade edilen pazarlama faturalarını ifade etmektedir.
    StudioExpense Stüdyo kullanım bedeli Stüdyo kullanım bedeli faturalarıdır.
    PriceDifferenceExpense Fiyat farkı bedeli Maliyetlerde meydana gelen değişikliklerin yansıtıldığı faturaları ifade eder.
    PriceDifferenceRefund Fiyat farkı iadesi Maliyetlerde meydana gelen değişikliklerin firma tarafından HB\'ye iletilmesini ifade etmektedir.
    LateInterestExpense Vade farkı gideri Vade farkı sebebiyle kesilen faturaladır.
    CargoCostRefund Kargo iade Kargo tutar iadesi sebebiyle düzenlediğiniz faturalardır.
    RoadAssistanceExpenseRefund Yol yardım iadesi İade edilen yol yardım faturalarını ifade etmektedir.
    RoadAssistanceExpense Yol yardım bedeli Yol yardım faturalarını ifade etmektedir.
    SponsorshipFee Sponsorluk bedeli Sponsorluk faturalarını ifade etmektedir.
    OverseasCommissionRefund Yurtdışı komisyon iadesi Yurtdışı siparişe ait iade edilen komisyon faturalarını ifade etmektedir.
    MpScrapExpense Hurda gideri Sipariş özelinde HB\'nın düzenlemiş olduğu memnuniyet faturalarını ifade etmektedir.
    MpCompensationIncome MP operasyon departmanı tazmin geliri Kampanya döneminde düzenlenen Hizmet Bedeli faturasının iadesidir.
    CargoCompensationExpenseRefund Kargo tazmin gideri iadesi Sipariş tazminleri için düzenlediğiniz faturaların iadesidir.
    VAT KDV Katma değer vergisi faturalarını ifade etmektedir.
    BalanceCorrection Düzeltme kaydı Muhasebe/Finans tarafından ekstre üzerinde uygulanan ters kayıt işlemlerini ifade etmektedir.
    SfsInterest TFS vade farkı TFS işlemi sonrası firmaya yansıtılan tfs gideri
    ProductsReportedByService MP servis raporlu ürünler MP Servis Raporlu Ürünler
    FacebookAdExpense MP Facebook reklam gideri Facebook reklam katılım bedeli faturalarıdır.
    CargoLimitExcessCompensationIncome Kargo limit aşımı tazmin geliri Sipariş tazminleri için kestiğiniz faturaları ifade eder.
    OrderBasedTransactions Sipariş bazlı kayıtlar Sipariş bazlı kayıtlarınızı listeler
    ContractualOrSpecialCaseTransactions Sözleşmeye bağlı / Özel durum kayıtlar Sözleşmeye bağlı / Özel durum kayıtlarınızı listeler
    CommissionSettlementTransactions Komisyon mahsuplaşma kayıtları Komisyon mahsup içerisinde yer alan tüm kayıtlarınızı listeler(Mahsup içerisindeki komisyon, kampanya indirimleri gibi.)
    InvoiceTransactions Faturalar Fatura tipindeki kayıtlarınızı listeler
    IncomeTransactions Tüm gelir kayıtları Gelir tipindeki tüm kayıtlarınızı listeler
    ExpenseTransactions Tüm gider kayıtları Gider tipindeki tüm kayıtlarınızı listeler
    AdBalanceTopUpFromAllowance Reklam Bakiye Yüklemesi Hak edişinizden reklam bakiyesi olarak yüklediğiniz tutarı ifade etmektedir. Kullanım detayları için Merchant paneldeki Reklam sayfasını ziyaret edebilirsiniz.
    AdBalanceTopUpFromAllowanceRefund Reklam bakiye iadesi Reklam bakiyenizden hak edişinize iade edilen tutarı ifade etmektedir.
    MarketingSupportParticipation Pazarlama Destek Katılım Fenomen reklamlarından gelen siparişleriniz için kesilen katılım tutarınızı ifade etmektedir.