Webhook modeli ile çalışacak firmaların aşağıda belirtilen kontratlar ile API lerini geliştirmeleri ve BaseURL lerini Hepsiburada’ya iletmeleri gerekmektedir.
Önemli Uyarı
Servise response iletirken idempotent mantığını kullanmanız önerilir.
https://{merchant_api_baseUrl}/orders
Not: {api_baseUrl} sizin tarafımıza ileteceğiniz urldir. Bu url altında "/orders" pathinde bir POST method bulunmalıdır.
{
"items": [
{
"dueDate": "2020-06-24T15:00:00",
"lastStatusUpdateDate": "2020-06-24T10:36:53.593",
"id": "5ef25338-dffc-2c00-01d8-dc1706060606",
"name": "Tahsildaroglu Çeçil Peyniri 250 gr",
"sku": "HBV00000NE0YY",
"productImageUrlFormat": "https://productimages.hepsiburada.net/s/1/{size}/9541384503346.jpg",
"quantity": 1,
"merchantId": "ab28300e-c126-4e70-a483-9f3fe0e5f297",
"totalPrice": {
"currency": "TRY",
"amount": 14.95
},
"unitPrice": {
"currency": "TRY",
"amount": 14.95
},
"hbDiscount": {
"totalPrice": {
"currency": "TRY",
"amount": 0
},
"unitPrice": {
"currency": "TRY",
"amount": 0
}
},
"vat": {
"currency": "TRY",
"amount": 1.2
},
"vatRate": 8,
"discountPriceToBeInvoicedHb": {
"currency": "TRY",
"amount": 1.4
},
"customerName": "Ahmet Aslan",
"CustomerId" : "161dd81f-6097-4c18-9189-2225aee977e0",
"status": "Delivered",
"shippingAddress": {
"addressId": "1dc456e8-d13c-46f4-80bd-d395608da395",
"address": "Serik caddesi bülbül sokak no37",
"name": "Ahmet Aslan",
"email": "[email protected]",
"countryCode": "TR",
"phoneNumber": "905079628210",
"alternatePhoneNumber": "905079628210",
"district": "MEHMET AKİF",
"city": "İstanbul",
"town": "ÜMRANİYE"
},
"invoice": {
"turkishIdentityNumber": "",
"taxNumber": "",
"taxOffice": null,
"address": {
"addressId": "1dc456e8-d13c-46f4-80bd-d395608da395",
"address": "Serik caddesi bülbül sokak no37",
"name": "Ahmet Aslan",
"email": "[email protected]",
"countryCode": "TR",
"phoneNumber": "905079628210",
"alternatePhoneNumber": "905079628210",
"district": "MEHMET AKİF",
"city": "İstanbul",
"town": "ÜMRANİYE",
"postalCode": "34774"
}
},
"sapNumber": "000010",
"dispatchTime": 0,
"commission": {
"currency": "TRY",
"amount": 1.39
},
"paymentTermInDays": 32,
"commissionType": 0,
"cargoCompanyModel": {
"id": 21,
"name": "HepsiJet",
"shortName": "HX",
"logoUrl": "https://images.hepsiburada.net/assets/cargo-logo/hepsijet.svg",
"trackingUrl": null
},
"cargoCompany": "HepsiJet",
"customizedText01": "",
"customizedText02": "",
"customizedText03": "",
"customizedText04": "",
"customizedTextX": "",
"creditCardHolderName": null,
"isCustomized": false,
"canCreatePackage": true,
"isCancellable": false,
"deliveryType": "AssignedDelivery",
"deliveryOptionCode": "",
"slot": {
"id": null,
"timeslot": "10:30-13:00"
},
"pickUpTime": "17:30 dummy",
"discountInfo": [],
"merchantSKU": "8691225154535",
"purchasePrice": {
"currency": "TRY",
"amount": 0
},
"deliveryNote": null,
"orderNumber": "1451124210",
"orderDate": "2020-09-15T16:06:51Z",
"warehouse": {
"shippingModel": "",
"shippingAddressLabel": ""
},
"deptorDifferenceAmount": 0,
"isJetDelivery": false
},
{
"dueDate": "2020-06-24T15:00:00",
"lastStatusUpdateDate": "2020-06-24T10:36:53.596",
"id": "5ef25338-dffc-2c00-01d8-dc1806060606",
"name": "Tahsildaroğlu Dil Peyniri 250 gr",
"sku": "HBV00000OE7ET",
"productImageUrlFormat": "https://productimages.hepsiburada.net/s/1/{size}/9541384503346.jpg",
"quantity": 1,
"merchantId": "ab28300e-c126-4e70-a483-9f3fe0e5f297",
"totalPrice": {
"currency": "TRY",
"amount": 14.95
},
"unitPrice": {
"currency": "TRY",
"amount": 14.95
},
"hbDiscount": {
"totalPrice": {
"currency": "TRY",
"amount": 0
},
"unitPrice": {
"currency": "TRY",
"amount": 0
}
},
"vat": {
"currency": "TRY",
"amount": 1.2
},
"vatRate": 8,
"discountPriceToBeInvoicedHb": {
"currency": "TRY",
"amount": 1.4
},
"customerName": "Ahmet Aslan",
"CustomerId" : "161dd81f-6097-4c18-9189-2225aee977e0",
"status": "Delivered",
"shippingAddress": {
"addressId": "1dc456e8-d13c-46f4-80bd-d395608da395",
"address": "Serik caddesi bülbül sokak no37",
"name": "Ahmet Aslan",
"email": "[email protected]",
"countryCode": "TR",
"phoneNumber": "905079628210",
"alternatePhoneNumber": "905079628210",
"district": "MEHMET AKİF",
"city": "İstanbul",
"town": "ÜMRANİYE"
},
"invoice": {
"turkishIdentityNumber": "",
"taxNumber": "",
"taxOffice": null,
"address": {
"addressId": "1dc456e8-d13c-46f4-80bd-d395608da395",
"address": "Serik caddesi bülbül sokak no37",
"name": "Ahmet Aslan",
"email": "[email protected]",
"countryCode": "TR",
"phoneNumber": "905079628210",
"alternatePhoneNumber": "905079628210",
"district": "MEHMET AKİF",
"city": "İstanbul",
"town": "ÜMRANİYE",
"postalCode": "34774"
}
},
"sapNumber": "000020",
"dispatchTime": 0,
"commission": {
"currency": "TRY",
"amount": 1.39
},
"paymentTermInDays": 32,
"commissionType": 0,
"cargoCompanyModel": {
"id": 21,
"name": "HepsiJet",
"shortName": "HX",
"logoUrl": "https://images.hepsiburada.net/assets/cargo-logo/hepsijet.svg",
"trackingUrl": null
},
"cargoCompany": "HepsiJet",
"customizedText01": "",
"customizedText02": "",
"customizedText03": "",
"customizedText04": "",
"customizedTextX": "",
"creditCardHolderName": null,
"isCustomized": false,
"canCreatePackage": true,
"isCancellable": false,
"isCancellableByHbAdmin": false,
"deliveryType": "AssignedDelivery",
"deliveryOptionId": "6",
"slot": {
"id": null,
"timeslot": "10:30-13:00"
},
"pickUpTime": "17:30 dummy",
"discountInfo": [],
"merchantSKU": "8691225152494",
"purchasePrice": {
"currency": "TRY",
"amount": 0
},
"deliveryNote": null,
"orderNumber": "1451124210",
"orderDate": "2020-09-15T16:06:51Z",
"warehouse": {
"shippingModel": "",
"shippingAddressLabel": ""
},
"deptorDifferenceAmount": 0,
"isJetDelivery": false,
"properties": [
{
"name": "Miktar",
"value": "10 kg",
"displayName": ""
},
{
"creationReason": "OrderCreated"
}
]
}
]
}
201 Created
| 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.
|
|
items.purchasePrice
|
Drop çalışan merchantlar için ürünün fiyat 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 içim: DeliveryCreated
|