Hepsiburada Market/Su/Çiçek Dikeyimizde Hizmet Veren Satıcılarımız,Sipariş Statü ve Akış Bilgilendirmesine Ait Web Servis Format Mimarisine Bu Sayfadan Erişim Sağlayabilirler.
Önemli
Sipariş Entegrasyonu methodlarımız ile ilgili sorularınız olması durumunda Sıkça Sorulan Sorular sayfamızı ziyaret edebilirsiniz.
Sipariş Verisi Alma
Son kullanıcılarımız Hepsiburada Hızlı Teslimat/Randevulu Teslimat uygulaması üzerinden sipariş oluşturduktan sonra ilgili siparişe ait detaylar,kalem bazlı(satır bazlı) olarak Hepsiburada tarafından,satıcılarımızın web servisine veri iletilir.Son kullanıcımız siparişin statüsünü bu aşama da Hepsiburada uygulamamızda İşleme Alınıyor şeklinde görmektedir.
Not
Webhook modeli ile çalışacak olan firmalarımızın aşağıda ifade edilen json kontrat ile bir web servis geliştirmeleri ve web servise ait BaseURL,username ve password bilgisini Hepsiburada Entegrasyon Ekibi’ne servis tanımı yapılabilmesi amacıyla ticket üzerinden iletmeleri gerekmektedir. (Web servis güvenliği Basic Auth ile sağlanır.)
Hepsiburada Webhook Servisleri üzerinde operasyonel akışı kesecek herhangi bir kontrol veya kısıt olmamalıdır.Siparişe ait veriler tarafınıza iletildikten sonra gerekli kontrollerinizi iç sistemlerinizde sağlayabilirsiniz.
- Method POST olarak ifade edilir.
Hepsiburada Tarafına Tanım İçin İletilmesi Gereken Örnek Satıcı Web Servis Url Bilgisi
https://{merchant_api_baseUrl}/orders
Hepsiburada Tarafından Web Servisinize İletilecek Örnek Json Request Formatı
{
"order":{
"maxProvisionAmount":{
"currency":"TRY",
"amount":46.00
},
"handlingFee":{
"currency":"TRY",
"amount":0.0
},
"isProvision":true,
"eta":59
},
"items":[
{
"dueDate":"2022-05-26T14:03:00Z",
"lastStatusUpdateDate":"2022-05-26T10:18:40.788Z",
"id":"628f53fc-5d40-f051-4b3d-435006060606",
"name":"Tat Coex Peri Peri Sos 225 gr",
"sku":"HBV00000NE0PX",
"unitPrice":{
"currency":"TRY",
"amount":10.91
},
"hbDiscount":{
"totalPrice":{
"currency":"TRY",
"amount":4.0932
},
"unitPrice":{
"currency":"TRY",
"amount":4.0932
}
},
"merchantDiscount":{
"totalPrice":{
"currency":"TRY",
"amount":0.0
},
"unitPrice":{
"currency":"TRY",
"amount":0.0
}
},
"vat":{
"currency":"TRY",
"amount":0.8728
},
"vatRate":8.0,
"customerName":"Muhammet Furkan DOĞAN",
"customerId":"8c53fe2f-910e-4689-bc63-b20cae6c824a",
"status":"Open",
"shippingAddress":{
"addressId":"31b9b6a3-86f4-489f-a275-5193be038b84",
"address":"trump MECİDİYEKÖY ŞİŞLİ İstanbul",
"name":"Muhammet Furkan DOĞAN",
"email":"[email protected]",
"countryCode":"TR",
"phoneNumber":"905315031756",
"alternatePhoneNumber":"905315031756",
"district":"MECİDİYEKÖY",
"city":"İstanbul",
"town":"ŞİŞLİ",
"coordinates":{
"latitude":"0",
"longitude":"0"
},
"directions":null
},
"invoice":{
"turkishIdentityNumber":null,
"taxNumber":"",
"taxOffice":"",
"address":{
"addressId":"31b9b6a3-86f4-489f-a275-5193be038b84",
"address":"trump MECİDİYEKÖY ŞİŞLİ İstanbul",
"name":"Muhammet Furkan DOĞAN",
"email":"[email protected]",
"countryCode":"TR",
"phoneNumber":"905315031756",
"alternatePhoneNumber":"905315031756",
"district":"MECİDİYEKÖY",
"city":"İstanbul",
"town":"ŞİŞLİ",
"coordinates":null,
"postalCode":null
}
},
"sapNumber":"000010",
"dispatchTime":1,
"commission":{
"currency":"TRY",
"amount":2.25
},
"paymentTermInDays":28,
"commissionType":0,
"cargoCompanyModel":{
"id":89100,
"name":"Mağaza Hesabı",
"shortName":"MP",
"logoUrl":"https://images.hepsiburada.net/assets/cargo-logo/magaza-hesabi.svg",
"trackingUrl":null
},
"cargoCompany":"Mağaza Hesabı",
"customizedText01":null,
"customizedText02":"",
"customizedText03":"",
"customizedText04":"",
"customizedTextX":"",
"creditCardHolderName":null,
"isCustomized":false,
"canCreatePackage":true,
"isCancellable":true,
"deliveryType":"AssignedDelivery",
"deliveryOptionId":5,
"slot":{
"id":null,
"timeSlot":"16:47-17:32",
"zoneId":null
},
"pickUpTime":"17:30 dummy",
"discountInfo":[
{
"campaignId":2000004302,
"campaignName":"EntegrasyonSepet50TL15TLİndirimOptInHX",
"campaignType":2,
"conditionOrAward":1,
"discountTotal":0.0,
"quantity":1,
"campaignDiscountRate":15.0,
"correlationId":"73589c71-9b32-4ec4-af6f-99df6486d657",
"isProtectedCampaign":false
},
{
"campaignId":2000004302,
"campaignName":"EntegrasyonSepet50TL15TLİndirimOptInHX",
"campaignType":2,
"conditionOrAward":2,
"discountTotal":4.09,
"quantity":1,
"campaignDiscountRate":15.0,
"correlationId":"73589c71-9b32-4ec4-af6f-99df6486d657",
"isProtectedCampaign":false
}
],
"merchantSku":"MPENT6",
"purchasePrice":{
"currency":"949",
"amount":0.0
},
"productImageUrlFormat":"https://productimages.hepsiburada.net/s/31/{size}/10336883212338.jpg",
"quantity":1,
"merchantId":"99197ff2-8998-456c-b8de-0cc71ebeaee2",
"totalPrice":{
"currency":"TRY",
"amount":10.91
},
"totalPriceWithoutDiscount":{
"currency":"TRY",
"amount":15.0032
},
"isCancellableByHbAdmin":true,
"discountPriceToBeInvoicedHb":{
"currency":"TRY",
"amount":0.0
},
"deliveryNote":{
"value":null,
"tags":["DoNotRingDoorBell","DoortoDoorDelivery"
]
},
"orderNumber":"2633901021",
"orderDate":"2022-05-26T10:18:33Z",
"orderNote":{
"value":null,
"tags":[
]
},
"warehouse":{
"shippingModel":"Standard",
"shippingAddressLabel":null
},
"deptorDifferenceAmount":0.0,
"isJetDelivery":false
},
{
"dueDate":"2022-05-26T14:03:00Z",
"lastStatusUpdateDate":"2022-05-26T10:18:40.796Z",
"id":"628f53fc-5d40-f051-4b3d-435106060606",
"name":"Mersoy Erzincan Tulum Peyniri 250 gr",
"sku":"HBV00000NE0R8",
"unitPrice":{
"currency":"TRY",
"amount":14.545
},
"hbDiscount":{
"totalPrice":{
"currency":"TRY",
"amount":10.9080
},
"unitPrice":{
"currency":"TRY",
"amount":5.4540
}
},
"merchantDiscount":{
"totalPrice":{
"currency":"TRY",
"amount":0.0
},
"unitPrice":{
"currency":"TRY",
"amount":0.0
}
},
"vat":{
"currency":"TRY",
"amount":2.3272
},
"vatRate":8.0,
"customerName":"Muhammet Furkan DOĞAN",
"customerId":"8c53fe2f-910e-4689-bc63-b20cae6c824a",
"status":"Open",
"shippingAddress":{
"addressId":"31b9b6a3-86f4-489f-a275-5193be038b84",
"address":"trump MECİDİYEKÖY ŞİŞLİ İstanbul",
"name":"Muhammet Furkan DOĞAN",
"email":"[email protected]",
"countryCode":"TR",
"phoneNumber":"905315031756",
"alternatePhoneNumber":"905315031756",
"district":"MECİDİYEKÖY",
"city":"İstanbul",
"town":"ŞİŞLİ",
"coordinates":{
"latitude":"0",
"longitude":"0"
},
"directions":null
},
"invoice":{
"turkishIdentityNumber":null,
"taxNumber":"",
"taxOffice":"",
"address":{
"addressId":"31b9b6a3-86f4-489f-a275-5193be038b84",
"address":"trump MECİDİYEKÖY ŞİŞLİ İstanbul",
"name":"Muhammet Furkan DOĞAN",
"email":"[email protected]",
"countryCode":"TR",
"phoneNumber":"905315031756",
"alternatePhoneNumber":"905315031756",
"district":"MECİDİYEKÖY",
"city":"İstanbul",
"town":"ŞİŞLİ",
"coordinates":null,
"postalCode":null
}
},
"sapNumber":"000020",
"dispatchTime":1,
"commission":{
"currency":"TRY",
"amount":3.00
},
"paymentTermInDays":28,
"commissionType":0,
"cargoCompanyModel":{
"id":89100,
"name":"Mağaza Hesabı",
"shortName":"MP",
"logoUrl":"https://images.hepsiburada.net/assets/cargo-logo/magaza-hesabi.svg",
"trackingUrl":null
},
"cargoCompany":"Mağaza Hesabı",
"customizedText01":null,
"customizedText02":"",
"customizedText03":"",
"customizedText04":"",
"customizedTextX":"",
"creditCardHolderName":null,
"isCustomized":false,
"canCreatePackage":true,
"isCancellable":true,
"deliveryType":"AssignedDelivery",
"deliveryOptionId":5,
"slot":{
"id":null,
"timeSlot":"16:47-17:32",
"zoneId":null
},
"pickUpTime":"17:30 dummy",
"discountInfo":[
{
"campaignId":2000004302,
"campaignName":"EntegrasyonSepet50TL15TLİndirimOptInHX",
"campaignType":2,
"conditionOrAward":1,
"discountTotal":0.0,
"quantity":2,
"campaignDiscountRate":15.0,
"correlationId":"73589c71-9b32-4ec4-af6f-99df6486d657",
"isProtectedCampaign":false
},
{
"campaignId":2000004302,
"campaignName":"EntegrasyonSepet50TL15TLİndirimOptInHX",
"campaignType":2,
"conditionOrAward":2,
"discountTotal":10.91,
"quantity":2,
"campaignDiscountRate":15.0,
"correlationId":"73589c71-9b32-4ec4-af6f-99df6486d657",
"isProtectedCampaign":false
}
],
"merchantSku":"MPENT8",
"purchasePrice":{
"currency":"949",
"amount":0.0
},
"productImageUrlFormat":"https://productimages.hepsiburada.net/s/31/{size}/10336883933234.jpg",
"quantity":2,
"merchantId":"99197ff2-8998-456c-b8de-0cc71ebeaee2",
"totalPrice":{
"currency":"TRY",
"amount":29.09
},
"totalPriceWithoutDiscount":{
"currency":"TRY",
"amount":39.9980
},
"isCancellableByHbAdmin":true,
"discountPriceToBeInvoicedHb":{
"currency":"TRY",
"amount":0.0
},
"deliveryNote":{
"value":null,
"tags":["DoNotRingDoorBell","DoortoDoorDelivery"
]
},
"orderNumber":"2633901021",
"orderDate":"2022-05-26T10:18:33Z",
"orderNote":{
"value":null,
"tags":[
]
},
"warehouse":{
"shippingModel":"Standard",
"shippingAddressLabel":null
},
"deptorDifferenceAmount":0.0,
"isJetDelivery":false
}
]
}
Response
Response 201 Created (Success)
Not
Servise response iletirken idempotent mantığını kullanmanız önerilir.
Alan Adı Açıklamaları
| Alan Adı | Açıklama |
|---|---|
|
items.dueDate
|
Siparişin teslimat tarihini belirtir.
|
|
items.slot
|
Müşterinin paketi teslim almak için seçtiği saat aralığıdır.
|
|
items.lastStatusUpdateDate
|
Sipariş içerisinde bulunan kalemin en son işlem gördüğü tarihtir.
|
|
items.id
|
Sipariş içerisindeki kalemlerin unique değeridir.
|
|
items.sku
|
Sipariş içerisindeki listinglerin HBSKU değeridir.
|
|
items.orderNumber
|
Sipariş numarasıdır.
|
|
items.orderDate
|
Siparişin oluşturulma tarihidir.Saat bilgisi UTC formatında gönderilir.
|
|
items.quantity
|
Siparişin içerisindeki kalemlerin adet sayısıdır.
|
|
items.merchantId
|
Merchantın uniqueId değeridir. (Test ve Canlı ortam için merchantId bilgisi hepsiburada.com tarafından iletilecektir.)
|
|
items.orderNote
|
Siparişte belirtilen not bilgisidir.
|
|
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
|
Siparişteki Hepsiburada tarafından karşılanan indirimli kalemlerin her birinin toplam adet tutarının para birimi cinsinden değeridir.
|
|
items.hbDiscount.totalPrice.amount
|
Siparişteki Hepsiburada tarafından karşılanan indirimli kalemlerin her birinin toplam adet tutarıdır.
|
|
items.hbDiscount.unitPrice.currency
|
Siparişteki Hepsiburada tarafından karşılanan tek bir indirimli kalemin tutarının para birimi cinsinden değeridir.
|
|
items.hbDiscount.unitPrice.amount
|
Siparişteki Hepsiburada tarafından karşılanan tek bir indirimli kalemin tutarının değeridir.
|
|
items.vat
|
KDV tutarıdır.
|
|
items.vatRate
|
KDV oranıdır.
|
|
items.customerName
|
Müşterinin adıdır.
|
|
items.customerId
|
string değer olup customer'a ait unique değerdir.
|
|
items.status
|
Siparişin durumunu belirtir. Open: Yeni sipariş 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.discountInfo
|
Kampanya var ise bu alanda bilgiler döner.
|
|
items.discountInfo.campaignType
|
1,2,3,6 değerlerini alır.DiscountRate = 1(enum),
DiscountAmount = 2(enum),
FixedPrice = 3(enum),
FreeShipping = 6(enum).DiscountRate: Yüzde kampanyalarını ifade eder.
Discountrate: 10 ise %10 kampanyası, Discountrate: 100 ise %100 kampanyası (hediye ürün, 3 al 2 öde etc. kurguları %100 discount giriliyor.)
DiscountAmount: TL kampanyalarını ifade eder. Discountamount: 50 ise 50 TL indirim kampanyasıdır. FreeShipping: Kargo bedava kampanyasını ifade eder. Teslimat ücreti alınmaz.
Fixedpriceamount: sabit fiyat kampanyasını ifade eder.Fixedpriceamount: 1 ise ürünün fiyatı 1 TL'ye sabitlenir.
|
|
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 / AssigneDelivery: Default değer olarak atanır.
|
|
items.deliveryOptionId
|
Siparişin teslim olacağı tarih bilgisini iletir. Alabileceği statüler: SAME_DAY_DELIVERY = 5, TOMORROW_DELIVERY = 6, STANDART_DELIVERY = 1
|
|
items.pickUpTime
|
Merchantın kargo firmasına teslim etmesi gereken saat aralığıdır.
|
|
items.merchantSku
|
Kaleme ait merchantsku(Satıcı stok) kodu bilgisidir.
|
|
items.purchasePrice
|
Drop çalışan merchantlar için ürünün fiyat bilgisidir.
|
|
items.shippingAddress.coordinates
|
Müşteriye ait adresin koordinat bilgileridir. (NOT:Eski mobil versiyonlarda ilgili datanın NULL gelebilme ihtimali mevcuttur. )
|
|
order.handlingFee
|
Teslimat ücreti.
|
|
order.maxProvisionAmount
|
Maksimum provizyon tutarı.
|
|
order.isProvision
|
True:CreditCard, False:Debitcard
|
|
items.totalPriceWithoutDiscount
|
Kalem bazlı indirimsiz toplam fiyat bilgisi
|
|
items.shippingAddress.directions
|
Adres tarifi bilgisi
|
|
items.merchantDiscount.totalPrice.currency
|
Siparişteki merchant tarafından karşılanan indirimli kalemlerin her birinin toplam adet tutarının para birimi cinsinden değeridir.
|
|
items.merchantDiscount.totalPrice.amount
|
Siparişteki merchant tarafından karşılanan indirimli kalemlerin her birinin toplam adet tutarıdır.
|
|
items.merchantDiscount.unitPrice.currency
|
Siparişteki merchant tarafından karşılanan tek bir indirimli kalemin tutarının para birimi cinsinden değeridir.
|
|
items.merchantDiscount.unitPrice.amount
|
Siparişteki merchant tarafından karşılanan tek bir indirimli kalemin tutarının değeridir.
|