API Reference

Webhook Önemli Bilgiler

Sipariş entegrasyonumuza ait olan , sipariş entegrasyonu webhook modelimiz ile hepsiburada’ya ileteceğiniz BaseURL’lere eventlerin iletilmesi olayıdır.

  • Webhook modeli ile çalışacak firmaların alt sayfalarda belirtilen kontratlar ile API lerini geliştirmeleri ve BaseURL lerini Hepsiburada’ya iletmeleri gerekmektedir.
  • IIS’de baseurl oluşturuldugunda default PUT servisi kapalı gelir, bunu açmanız gerekir.
  • Servise response iletirken idempotent mantığını kullanmanız önerilir.

    • Create Order

    Alan Açıklamaları

    Alan Adı Açıklama
    items.dueDate
    Siparişin kargoya verilmesi gereken son teslim tarihini belirtir.
    items.lastStatusUpdateDate
    Sipariş içerisinde bulunan kalemin enson işlem gördüğü tarihtir.
    items.id
    Sipariş içerisindeki kalemlerin unique değeridir. (Aynı pakete konulabilecek kalemleri listeleme endpointinde kullanılacaktır.)
    items.sku
    Sipariş içerisindeki listinglerin HBSKU değeridir.
    items.orderNumber
    Sipariş numarasıdır.
    items.orderDate
    Siparişin oluşturulma tarihidir.
    items.quantity
    Siparişin içerisindeki kalemlerin adet sayısıdır.
    items.merchantId
    Merchantın uniqueId değeridir. (Test(Sıt) ve canlı ortam için merchantId bilgisi hepsiburada.com tarafından iletilecektir.)
    items.totalPrice.currency
    Siparişteki kalemlerin her birinin toplam adet tutarının para birimi cinsinden değeridir.
    items.totalPrice.amount
    Siparişteki kalemlerin her birinin toplam adet tutarıdır.
    items.unitPrice.currency
    Siparişteki tek bir kalemin tutarının para birimi cinsinden değeridir.
    items.unitPrice.amount
    Siparişteki tek bir kalemin tutarının değeridir.
    items.hbDiscount.totalPrice.currency
    items.hbDiscount.totalPrice.amount
    items.hbDiscount.unitPrice.currency
    items.hbDiscount.unitPrice.amount
    items.vat
    KDV tutarıdır.
    items.vatRate
    KDV oranıdır.
    items.customerName
    Müşterinin adıdır.
    items.status
    Siparişin durumunu belirtir. Open: Yeni sipariş belirtir. / Unpacked: Paketi bozulan siparişleri belirtir.
    items.shippingAddress
    Teslimat adresidir.
    items.invoice
    Fatura bu alan içerisindeki bilgiler ile oluşturulmalıdır.
    items.invoice.turkishIdentityNumber
    Müşterinin T.C numarasıdır.
    items.invoice.taxNumber
    Müşterinin vergi dairesinin numarasıdır.
    items.invoice.taxOffice
    Müşterinin vergi dairesinin adıdır.
    items.invoice.address
    Siparişin fatura adresidir.
    items.invoice.address.addressId
    Siparişin hepsiburada.com üzerindeki unique değeridir.
    items.invoice.address.address
    Fatura adresinin açık adresidir.
    items.invoice.address.name
    Fatura adresinin isim bilgisidir.
    items.invoice.address.email
    Fatura adresinin mail bilgisidir.
    items.invoice.address.countryCode
    Fatura adresinin ülke bilgisinin kısa kodudur.
    items.invoice.address.phoneNumber
    Fatura adresinin telefon numarasıdır.
    items.invoice.address.alternatePhoneNumber
    Fatura adresinin alternarif telefon numarasıdır.
    items.invoice.address.district
    Fatura adresinin mahalle bilgisidir.
    items.invoice.address.city
    Fatura adresinin şehir bilgisidir.
    items.invoice.address.town
    Fatura adresinin ilçe bilgisidir.
    items.sapNumber
    Hepsiburada.com tarafında siparişin içerisinde bulunan kalemlerin sıra bilgisini verir.
    items.dispatchTime
    Siparişin kargoya verilme süresidir.
    items.commission
    Hepsiburada.com üzerinden alınan komisyondur.
    items.commission.currency
    Hepsiburada.com üzerinden alınan komisyon bedelinin komisyon cinsinden değeridir.
    items.commission.amount
    Hepsiburada.com üzerinden alınan komisyon bedelidir.
    items.paymentTermInDays
    Listing bazında merchanta ödeme yapılacağı gün verisidir.
    items.commissionType
    Hepsiburada.com tarafındaki komisyon bedelinin unique değeridir.
    items.cargoCompanyModel.id
    Kargo firmasının hepsiburada.com üzerindeki unique değeridir.
    items.cargoCompanyModel.name
    Listingin üzerine tanımlı kargo firmasının isim bilgisidir.
    items.cargoCompanyModel.shortName
    Listingin üzerine tanımlı kargo firmasının kısa isim bilgisidir.
    items.cargoCompanyModel.logoUrl
    Listingin üzerine tanımlı kargo firmasının logo url bilgisidir.
    items.cargoCompanyModel.trackingUrl
    Listingin paketlendikten sonraki kargo takip urlini belirtir.
    items.cargoCompany
    Listingin üzerine tanımlı kargo firmasının isim bilgisidir.
    items.customizedText01
    Özelleştirilebilir ürünün içerik bilgisini verir.
    items.customizedText02
    Özelleştirilebilir ürünün içerik bilgisini verir.
    items.customizedText03
    Özelleştirilebilir ürünün içerik bilgisini verir.
    items.customizedText04
    Özelleştirilebilir ürünün içerik bilgisini verir.
    items.customizedTextX
    Özelleştirilebilir ürünün içerik bilgisini verir.
    items.discountPriceToBeInvoicedHb
    HB'nin karşıladığı kampanyalar için merchant'ın kesmesi gereken fatura tutarıdır
    items.creditCardHolderName
    Sipariş verilen kartın üzerinde bulunan isim bilgisidir.
    items.isCustomized
    Sipariş verilen kalemin kişinin isteklerine göre özelleştirilebilir ürün olduğunu belirtir. True: Özelleştirilebilir ürün. False: Özelleştirilemeyen ürün
    items.canCreatePackage
    Ürünün paketlenebilir ürün olduğunu belirtir.
    items.isCancellable
    Listingin iptal edilme durumudur. True: İptal edilebilir ürün / False: İptal edilemez ürün
    items.isCancellableByHbAdmin
    Listingin Hbadmin tarafından iptal edilebilirlik durumudur. True: Hbadmin tarafından iptal edilebiir. / False: Hbadmin tarafından iptal edilemez.
    items.deliveryType
    Teslimatın teslim verisidir. StandardDelivery: Standart teslimat / BT: Bugün Teslimat / YT: Yarın teslimat
    items.deliveryOptionId
    Siparişin teslim olacağı tarih bilgisini iletir. Alabileceği statüler: SAME_DAY_DELIVERY = 5, TOMORROW_DELIVERY = 6, STANDART_DELIVERY = 1
    items.slot
    Müşterinin paketi teslim almak için seçtiği saat aralığıdır.
    items.pickUpTime
    Merchantın kargo firmasına teslim etmesi gereken saat aralığıdır.
    items.merchantSku
    Kaleme ait merchantsku(Satıcı stok) kodu bilgisidir.
    unitmerchantDiscount.amount
    Merchant tarafından uygulanan birim indirim tutarı
    totalmerchantDiscount.amount
    Merchant tarafından uygulanan toplam indirim tutarı
    items.purchasePrice
    Drop çalışan merchantlar için ürünün fiyat bilgisidir.
    items.creationReason
    Siparişin hangi method ile oluştuğu bilgisidir.
    items.creationReason
    Siparişin hangi method ile tekrar yaratıldığını iletmektedir.Yeni Yaratılan : OrderCreated Transfer için : OrderLineTransferred Resend için : OrderLineResend Değişim için : ClaimChangeAccepted Parçalı paketleme : DeliveryCreated

    Intransit

    Alan Açıklamaları

    Alan Adı Açıklama
    merchantId
    Merchantın uniqueId değeridir. (Test(Sıt) ve canlı ortam için merchantId bilgisi hepsiburada.com tarafından iletilecektir.)
    shippedDate
    Siparişin kargoya teslim edilme tarihidir.
    packageNumber
    Paket numarası bilgisidir.
    barcode
    Paketin kargo barkod bilgisidir.
    trackingInfoCode
    Paketin kargo takip kodudur.
    trackingInfoUrl
    Paketin kargo takip url bilgisidir.

    Deliver

    Alan Açıklamaları

    Alan Adı Açıklama
    merchantId
    Merchantın uniqueId değeridir. (Test(Sıt) ve canlı ortam için merchantId bilgisi hepsiburada.com tarafından iletilecektir.)
    receivedDate
    Paketin teslim edilme tarihidir.
    receivedBy
    Paket teslim edildiği kişi bilgisidir.
    packageNumber
    Paket numarası bilgisidir.
    barcode
    Paketin kargo barkod bilgisidir.

    Undeliver

    Alan Açıklamaları

    Alan Adı Açıklama
    merchantId
    Merchantın uniqueId değeridir. (Test(Sıt) ve canlı ortam için merchantId bilgisi hepsiburada.com tarafından iletilecektir.)
    undeliveredDate
    Paketin teslim edilmediği tarih bilgisidir.
    undeliveredReason
    Paketin teslim edilememe nedenidir.
    packageNumber
    Paketin paket numarasıdır.
    barcode
    Paketin kargo barkod bilgisidir.

    Order Cancel

    Alan Açıklamaları

    Alan Adı Açıklama
    cancelDate
    Siparişin iptal edilme tarihidir.
    merchantId
    İptal edilen siparişin hangi merchanta ait olduğunu gösteren merchantıd bilgisidir.
    id
    Siparişin kaleminin unique ID bilgisidir.
    quantity
    Siparişin iptal edilen kaleminin kaç adet olduğunu belirtir.
    cancelledBy
    Siparişin kimin tarafından iptal edildiğinin bilgisini iletir. Alabileceği statüler : Merchant, Customer,Fraud
    cancelReasonCode
    Sipariş iptal nedenidir.

    Create Packages

  • Önceden sipariş paketlendikten sonra paket listesini alabilmek için Paket Bilgilerini Listeleme (https://oms-external-sit.hepsiburada.com/packages/merchantid/{merchantid}?timespan=24) endpointine istek atılması gerekiyordu.Bu yapı ile birlikte paket oluşturma işlemi sonrasında , pakete ait tüm bilgiler (paket bilgilerini listeleme endpointinde olduğu şekliyle) tarafınızdan oluşturulacak ve hepsiburada’ya iletilecek olan url’e post edilecektir

    • Unpack

  • Halihazırda kullanılan modelde unpacked yapılan paketler “Satıcıya Ait Paket Bilgilerini Listeleme” endpointinden alınmaktaydı. Webhook modelinde ise unpacked yapılan paket bilgisi , hepsiburada tarafından bize iletmiş olduğunuz URL’e push (PUT) edilecektir. Satıcıya Ait Paket Bilgilerini Listeleme endpoint’i üzerinden tekrar sorgulama yapmanıza gerek bulunmamaktadır.

    • Change Shipping Address Order

    Webhook sürecindeki bu metod ile teslimat adresi değişikliklerini alabileceksiniz.
    Alan Açıklamaları

    Alan Adı Açıklama
    orderNumber
    Sipariş numarasıdır.
    addressId
    Siparişin hepsiburada.com üzerindeki unique değeridir.
    address
    Müşterinin teslimat adresidir.
    name
    Müşterinin adıdır.
    email
    Müşterinin mail bilgisidir.
    countryCode
    Ülke bilgisinin kısa kodudur.
    phoneNumber
    Müşterinin telefon numarasıdır.
    alternatePhoneNumber
    Müşterinin alternarif telefon numarasıdır.
    district
    Müşterinin mahalle bilgisidir.
    city
    Müşterinin şehir bilgisidir.
    town
    Müşterinin ilçe bilgisidir.