Önemli
Sipariş Entegrasyonu methodlarımız ile ilgili sorularınız olması durumunda Sıkça Sorulan Sorular sayfamızı ziyaret edebilirsiniz.
Toplanıyor Statüsü
Bu methodumuza entegre olan satıcılarımız siparişin statüsünü Toplanıyor şeklinde gösterir.
İşleme Alınıyor ve Hazırlandı statüleri arasındaki ara statüdür.Son kullanıcılarımız siparişin statüsünü bu aşama da Hepsiburada uygulamamızda Toplanıyor şeklinde görmektedir.Market dikeyindeki satıcılarımız operasyonel akışları gereği mutlaka methoda entegre olmalıdır.Su ve Çiçek dikeyindeki satıcılarımız için bu method kullanımı opsiyoneldir.
Not
Bu method kullanıldığında son kullanıcı iptali uygulama üzerinde kapatılır,sadece satıcı ve müşteri hizmetleri iptali sağlanabilir.
- API, HTTP Basic Auth. ile korunmaktadır, dolayısıyla istemci, kullanıcı adı ve şifreyi HTTP Authorization Header bilgisinde göndermelidir.
Parametreler(Parameters)
| merchantid | (gerekli, guid, b2910839-83b9-4d45-adb6-86bad457edcb) ; Her satıcı mağazanın/bayinin unique bilgisidir. |
| OrderNumber | Siparişe ait unique numara bilgisidir. |
Hata Durumları
Hata Kodu |
Hata Mesajı |
|---|---|
|
400
|
Bad Request: URL içerisindeki parametreleri kontrol edin.
|
|
401
|
Unauthorized: Username veya Password (Şifre) hatalı girilmiştir. Lütfen kontrol ediniz.
|
|
404
|
Not Found: URL hatalı gönderilmiştir. Lütfen kontrol ediniz.
|
|
405
|
Not Allowed: Http Protokol hatası. Lütfen kontrol ediniz.
|
|
500
|
Internal Server: Lütfen ticket üzerinden entegrasyon ekibi ile iletişime geçiniz.
|
Siparişte Düzenleme Sağlama
Bu methodumuza entegre olan satıcılarımız,son kullanıcılarımızın siparişindeki kalemde(satırda) ifade edilen üründe ölçü(gramaj)/miktar(adet)/fiyat değişikliği sağlayabilir ve muadil ürün önerebilir. İlgili method siparişi Toplanıyor statüsüne aldıktan sonra,Hazırlandı statüsüne getirmeden önce kullanılmalıdır.
- API, HTTP Basic Auth. ile korunmaktadır, dolayısıyla istemci, kullanıcı adı ve şifreyi HTTP Authorization Header bilgisinde göndermelidir.
Parametreler(Parameters)
| merchantid | (gerekli, guid, b2910839-83b9-4d45-adb6-86bad457edcb) ; Her satıcı mağazanın/bayinin unique bilgisidir. |
| lineitemid | Siparişteki kaleme(satıra) ait unique kod bilgisidir. |
Not
newSku ve newMerchantSku değerleri aynı anda dolu gönderilemez.
Gramajlı ürünler için newGram,adetli ürünler için ise newQuantity parametresi dolu gönderilmelidir.
Muadil ürün önerilirken newSku veya newMerchantSku bilgisine muadil ürünün bilgileri beliritlmelidir.
Kalem(satır) bilgisi değiştirildiği için endpointte ifade edilen kalem bilgisi sistemiz tarafından otomatik iptal edilerek response da ifade edilen yeni kalem id bilgisi geçerli olmaktadır.Siparişi Hazırlandı statüsüne alırken yeni kalem id değeri kullanılmalıdır.
Method kullanımı sonrasında Siparişe Ait Detay Listeleme methodumuzu kullanarak güncel durum bilgisini temin edebilirsiniz.(Örneğin Fiyat değişikliği teyidi için,yeni fiyat bilgisini öğrenmek için gibi)
Alan Adı Açıklamaları
Alan Adı |
Açıklama |
|---|---|
|
newSku
|
Envanterde ifade edilen ürünün Hepsiburada sistemi tarafından tanımlanan unique kod bilgisidir.
|
|
newMerchantSku
|
Envanterde ifade edilen ürünün satıcı tarafından tanımlanan unique kod bilgisidir.Satıcı stok kodu olarak ifade edilir.Satıcı tarafından ürün yaratılırken bu bilgi belirtilmiştir.
|
|
newQuantity
|
Miktar/adet bilgisini belirtir.
|
|
newGram
|
Ölçü/gramaj bilgisini belirtir.
|
|
newLineItemId
|
Sipariş içerisinde değiştirilen kalemin yerine tanımlanan yeni kalemin unique kod değeridir.
|
Hata Durumları
| HataKodu | Hata Mesajı |
|---|---|
|
400
|
Bad Request: URL içerisindeki parametreleri kontrol edin.
|
|
401
|
Unauthorized: Password ve şifre hatalı girilmiştir. Lütfen kontrol ediniz.
|
|
404
|
Not Found: URL hatalı gönderilmiştir. Lütfen kontrol ediniz. İstek gönderdiğiniz lineitemId ile işlem yapılamamaktadır.Id bulunmamaktadır veya MerchantId değeri bulunamamaktadır.Değerleri kontrol ediniz.
|
|
405
|
Not Allowed: Http Protokol hatası. Lütfen kontrol ediniz.
|
|
409
|
Conflict: Maksimum %15'lik provizyon kuralına dikkat edilmelidir.%15 üzeri oran farkı olduğu zaman hata alınmaktadır.
|
|
500
|
Internal Server: Lütfen ticket üzerinden entegrasyon ekibi ile iletişime geçiniz.
|
Satıcı İptal Bilgisi Gönderme
Kalem bazlı methodumuza ve sipariş bazlı methodumuza entegre olan satıcılarımız,siparişin içeriğinde kalem(satır) bazlı veya siparişin tümü için iptal bilgisini Hepsiburada sistemine gönderebilir.
İlgili method sadece statüsü open(İşleme Alınıyor) ve picking(Toplanıyor) olan siparişler için geçerlidir. Yani bir sipariş paketlenip Hazırlandı statüsüne getirilir ise,bu endpoint kullanılamaz. Eğer siparişin paketi var ise önce paket bozulup daha sonra bu endpoint çağırılmalıdır.
Toplanıyor statüsünde olan siparişlerin satıcı iptalini gerçekleştirebilmeniz için bu method kullanılır.
- API, HTTP Basic Auth. ile korunmaktadır, dolayısıyla istemci, kullanıcı adı ve şifreyi HTTP Authorization Header bilgisinde göndermelidir.
Parametreler(Parameters)
| merchantid | (gerekli, guid, b2910839-83b9-4d45-adb6-86bad457edcb) ; Her satıcı mağazanın/bayinin unique bilgisidir. |
| lineitemid | Siparişteki kaleme(satıra) ait unique kod bilgisidir. |
| OrderNumber | Siparişe ait unique numara bilgisidir. |
ReasonId Bilgileri
26:Müşteri Vazgeçti
82:Satışa Uygun Değil
83:Ürün Stokta Yok
42: Hizmet Dışı Bölge
43: Müşteriye Ulaşılamadı
Alan Adı Açıklamaları
| Alan Adı | Açıklama |
|---|---|
|
reasonId
|
İletmek istediğiniz iptal sebebi.
|
Hata Durumları
Hata Kodu |
Hata Mesajı |
|---|---|
|
400
|
Bad Request: URL içerisindeki parametreleri kontrol edin.
|
|
401
|
Unauthorized: Username veya Password (Şifre) hatalı girilmiştir. Lütfen kontrol ediniz.
|
|
404
|
Not Found: URL hatalı gönderilmiştir. Lütfen kontrol ediniz.
|
|
405
|
Not Allowed: Http Protokol hatası. Lütfen kontrol ediniz.
|
|
500
|
Internal Server: Lütfen ticket üzerinden entegrasyon ekibi ile iletişime geçiniz.
|
Siparişe Ait Detay Listeleme
Bu methodumuza entegre olan satıcılarımız,sipariş numarasını sorgulayarak siparişe ait kalemlerin detaylarını listeleyebilir.
- API, HTTP Basic Auth. ile korunmaktadır, dolayısıyla istemci, kullanıcı adı ve şifreyi HTTP Authorization Header bilgisinde göndermelidir.
Parametreler(Parameters)
| merchantid | (gerekli, guid, b2910839-83b9-4d45-adb6-86bad457edcb) ; Her satıcı mağazanın/bayinin unique bilgisidir. |
| OrderNumber | Siparişe ait unique numara bilgisidir. |
Sipariş Detay Listeleme Statüleri
Statü |
Açıklama |
|---|---|
|
Open
|
Açık sipariş.
|
|
Packaged
|
Paketlenmiş sipariş.
|
|
CancelledByMerchant
|
Merchant tarafından iptal edilmiş sipariş.
|
|
Delivered
|
Teslim edilmiş sipariş.
|
|
InTransit
|
Kargoda olan sipariş.
|
|
ClaimCreated
|
Talep açılmış kalem.
|
|
CancelledByCustomer
|
Müşteri tarafından iptal edilmiş sipariş.
|
|
CancelledBySap
|
SAP tarafından iptal edilen sipariş Fraud vb durumlarda oluşur.
|
|
Picking
|
Sipariş Toplanıyor aşamasında.
|
Hazırlandı Statüsü
Bu methodumuza entegre olan satıcılarımız,siparişteki kalem(satır) veya kalemleri(satırları) paketleyebilir.
Son kullanıcı siparişin statüsünü bu aşama da Hepsiburada uygulamamızda Hazırlandı şeklinde görmektedir.
- API, HTTP Basic Auth. ile korunmaktadır, dolayısıyla istemci, kullanıcı adı ve şifreyi HTTP Authorization Header bilgisinde göndermelidir.
Parametreler(Parameters)
| merchantid | (gerekli, guid, b2910839-83b9-4d45-adb6-86bad457edcb) ; Her satıcı mağazanın/bayinin unique bilgisidir. |
| lineitemid | Siparişteki kaleme(satıra) ait unique kod bilgisidir. |
| Quantity | (gerekli, int, 2) ; Paket içerisinde bulunan kalemin adet sayısı. |
Not
Siparişte birden fazla kalem olduğu durumda, tek kalem bazlı paketleme akış gereği yapılamamaktadır.
Alan Adı Açıklamaları
Alan Adı |
Açıklama |
|---|---|
|
lineItemRequests.id
|
İlgili kalemin unique değeridir.
|
|
lineItems.quantity
|
İlgili kalemin adet değeridir.
|
|
packageNumber
|
Oluşturduğunuz paketin numarasıdır.
|
|
parcelQuantity
|
Paketteki koli adedi (opsiyonel)
|
|
deci
|
Paket desi bilgisi (opsiyonel)
|
Hata Durumları
| HataKodu | Hata Mesajı |
|---|---|
|
400
|
Bad Request: URL içerisindeki parametreleri kontrol edin.
|
|
401
|
Unauthorized: Password ve şifre hatalı girilmiştir. Lütfen kontrol ediniz.
|
|
404
|
Not Found: URL hatalı gönderilmiştir. Lütfen kontrol ediniz. İstek gönderdiğiniz limeitem.Id ile paketlenebilecek bir lineıtem.Id bulunmamaktadır.
|
|
405
|
Not Allowed: Http Protokol hatası. Lütfen kontrol ediniz.
|
|
409
|
Conflict: İstek gönderdiğiniz lineıtem.Id zaten paketlenmiş veya iptal edilmiş olabilir.
|
|
500
|
Internal Server: Lütfen ticket üzerinden entegrasyon ekibi ile iletişime geçiniz.
|
Hazırlandı Statüsünü Geri Alma
Bu methodumuza entegre olan satıcılarımız,siparişin paketini bozabilir.Son kullanıcılarımız siparişin statüsünü bu aşama da Hepsiburada uygulamamızda Hazırlandı yerine bir önceki statüsünde görür.
- API, HTTP Basic Auth. ile korunmaktadır, dolayısıyla istemci, kullanıcı adı ve şifreyi HTTP Authorization Header bilgisinde göndermelidir.
Parametreler(Parameters)
| merchantid | (gerekli, guid, b2910839-83b9-4d45-adb6-86bad457edcb) ; Her satıcı mağazanın/bayinin unique bilgisidir. |
| packagenumber | (gerekli, string, 0254621) Her paketin unique bir kod bilgisidir. |
Yolda/Teslim Edildi/Teslim Edilemedi Statüleri(Taşımacılık Satıcı Üzerinde)
- API, HTTP Basic Auth. ile korunmaktadır, dolayısıyla istemci, kullanıcı adı ve şifreyi HTTP Authorization Header bilgisinde göndermelidir.
Parametreler(Parameters)
| merchantid | (gerekli, guid, b2910839-83b9-4d45-adb6-86bad457edcb) ; Her satıcı mağazanın/bayinin unique bilgisidir. |
| packagenumber | (gerekli, string, 0254621) Her paketin unique bir kod bilgisidir. |
Bu methodumuza entegre olan satıcılarımız siparişin statüsünü Yolda şeklinde gösterir.
Son kullanıcılarımız siparişin statüsünü bu aşama da Hepsiburada uygulamamızda Yolda şeklinde görmektedir.
Alan Açıklamaları
| Alan Adı | Açıklama |
|---|---|
|
shippedDate
|
Paketin kuryeye veriliş tarihi.Saat bilgisi UTC formatında gönderilmelidir.(Zorunlu alan)
|
|
estimatedArrivalDate
|
Paketin tahmini teslim tarihi.Saat bilgisi UTC formatında gönderilmelidir.(Zorunlu alan)
|
|
trackingUrl
|
Kurye takip Url bilgisi
|
|
trackingNumber
|
Kurye takip numarası
|
|
trackingPhoneNumber
|
Kurye takip telefon numarası
|
|
tax
|
Paketin kdv bilgisi 0 gönderilmelidir.
|
|
cost
|
Paketin tutarı (0 gönderilmelidir.)
|
|
deci
|
Paketin desi bilgisi
|
Bu methodumuza entegre olan satıcılarımız siparişin statüsünü Teslim Edildi şeklinde gösterir.
Son kullanıcılarımız siparişin statüsünü bu aşama da Hepsiburada uygulamamızda Teslim Edildi şeklinde görmektedir.
Alan Açıklamaları
| Alan Adı | Açıklama |
|---|---|
|
receivedDate
|
Paketin teslim tarihi.Saat bilgisi UTC formatında gönderilmelidir.
|
|
receivedBy
|
Paketin teslim edildiği kişi bilgisi
|
Bu methodumuza entegre olan satıcılarımız siparişin statüsünü Teslim Edilemedi şeklinde gösterir.
Son kullanıcılarımız siparişin statüsünü bu aşama da Hepsiburada uygulamamızda Teslim Edilemedi şeklinde görmektedir.
Alan Açıklamaları
| Alan Adı | Açıklama |
|---|---|
|
undeliveredDate
|
Paketin teslim edilemediği tarih.Saat bilgisi UTC formatında gönderilmelidir.
|
|
undeliveredReason
|
Paketin neden teslim edilemediği bilgisinin iletileceği alandır. Alabileceği değerler : CustomerDoesNotWantProduct (Müşteri ürünü istemiyor) , CustomerUnreachable(Müşteriye ulaşılamadı.)
|
Hata Durumları
| Hata Kodu | Hata Mesajı |
|---|---|
|
400
|
Bad Request: URL içerisindeki parametreleri kontrol edin.
|
|
401
|
Unauthorized: Password ve şifre hatalı girilmiştir. Lütfen kontrol ediniz.
|
|
404
|
Not Found: URL hatalı gönderilmiştir. Lütfen kontrol ediniz.
|
|
405
|
Not Allowed: Http Protokol hatası. Lütfen kontrol ediniz.
|
|
500
|
Internal Server: Lütfen ticket üzerinden entegrasyon ekibi ile iletişime geçiniz.
|
Siparişe Fiş Görseli Ekleme/Silme
Bu methodumuza entegre olan satıcılarımız,siparişe fiş görseli ekleyebilir veya siparişte mevcut olan fiş görselini silebilir.
- API, HTTP Basic Auth. ile korunmaktadır, dolayısıyla istemci, kullanıcı adı ve şifreyi HTTP Authorization Header bilgisinde göndermelidir.
Parametreler(Parameters)
| merchantid | (gerekli, guid, b2910839-83b9-4d45-adb6-86bad457edcb) ; Her satıcı mağazanın/bayinin unique bilgisidir. |
| ordernumber | Siparişe ait unique numara bilgisidir. |
Not
Maksimum 5 adet fiş görseli yüklenir.Daha fazla fiş görseli yüklenmek istenildiğinde OrderSlipStorageCapacityExceeded hatası alınır.
Fiş görselini ekledikten sonra Siparişe Ait Detay Listeme methodu ile kontrol sağlayabilirsiniz.
Alan Açıklamaları
| Alan Adı | Açıklama |
|---|---|
|
FilesAsBase64
|
Fiş görsel linkinin base 64 hali.
|
|
ImageName
|
Fiş resminin adı.
|
|
IsDeleted
|
False(silinmedi),True(silindi).
|
|
SlipUrl
|
Fiş resminin urli.
|
Hata Durumları
| HataKodu | Hata Mesajı |
|---|---|
|
500
|
Internal Server: Lütfen ticket üzerinden entegrasyon ekibi ile iletişime geçiniz.
|
|
400
|
Bad Request: URL içerisindeki parametreleri kontrol edin.
|
|
401
|
Unauthorized: Password ve şifre hatalı girilmiştir. Lütfen kontrol ediniz.
|
|
404
|
Not Found: URL hatalı gönderilmiştir. Lütfen kontrol ediniz.
|
|
405
|
Not Allowed: Http Protokol hatası. Lütfen kontrol ediniz.
|
Siparişin Kampanya Bilgisini Listeleme
Bu methodumuza entegre olan satıcılarımız siparişe ait uygulanan kampanya varsa, kampanyaya ait detay bilgilere erişim sağlayabilir.
- API, HTTP Basic Auth. ile korunmaktadır, dolayısıyla istemci, kullanıcı adı ve şifreyi HTTP Authorization Header bilgisinde göndermelidir.
Parametreler(Parameters)
| merchantid | (gerekli, guid, b2910839-83b9-4d45-adb6-86bad457edcb) ; Her satıcı mağazanın/bayinin unique bilgisidir. |
| orderNumber | Siparişe ait unique numara bilgisidir. |
Alan Açıklamaları
| Alan Adı | Açıklama |
|---|---|
|
conditionOrAward
|
Condition ya da Award değeri dönecektir.
|
|
campaignType
|
DiscountRate, DiscountAmount, FixedPrice ya da FreeShipping
|
Hata Durumları
| HataKodu | Hata Mesajı |
|---|---|
|
400
|
Bad Request: URL içerisindeki parametreleri kontrol edin.
|
|
401
|
Unauthorized: Password ve şifre hatalı girilmiştir. Lütfen kontrol ediniz.
|
|
404
|
Not Found: URL hatalı gönderilmiştir. Lütfen kontrol ediniz. OrderHasNoCampaign, Siparişe ait gösterilebilecek kampanya bilgisi bulunamadı.
|
|
405
|
Not Allowed: Http Protokol hatası. Lütfen kontrol ediniz.
|
|
500
|
Internal Server: Lütfen ticket üzerinden entegrasyon ekibi ile iletişime geçiniz.
|
Numara Maskeleme
Bu methodumuza entegre olan satıcılarımız,son kullanıcılarımız ile Toplayıcı veya Dağıtıcı ekip arkadaşları arasında iletişim sağlanabilmesi adına maskelenmiş çağrı başlatabilir.İlgili methodun kullanılabilmesi adına Toplama veya Dağıtım süreci firmanın kendisinde olmalıdır.
Çağrı sadece prod(canlı) ortamda başlatılabilir.
- API, HTTP Basic Auth. ile korunmaktadır, dolayısıyla istemci, kullanıcı adı ve şifreyi HTTP Authorization Header bilgisinde göndermelidir.
Request(POST)
https://hepsiexpress-agent-api.hepsiburada.com/v1/triggercallforexternalagent
{
"orderNumber": "1234567890",
"phoneNumber": "5551119900",
"name": "Örnek Kurye"
}
Response
200 OK
Alan Açıklamaları
| Alan Adı | Açıklama |
|---|---|
|
orderNumber
|
10 haneli Hepsiexpress sipariş numarası.
|
|
phoneNumber
|
Müşteri ile görüşecek kişinin 10 haneli telefon numarası (Sabit hat girilmemelidir.)
|
|
name
|
Müşteri ile görüşecek kişinin ismi.
|
Hata Durumları
| Alan Adı | Açıklama |
|---|---|
|
400
|
Bad Request:Gönderilen istek parametreleri geçersiz.(Sabit hat numarası belirtilmiş olabilir kontrol ediniz).
|
|
401
|
Unauthorized: Password ve şifre hatalı girilmiştir. Lütfen kontrol ediniz.
|
|
500
|
Internal Server: Lütfen ticket üzerinden entegrasyon ekibi ile iletişime geçiniz.
|
|
404
|
Order Not Found: Order numarası eksik veya hatalı kontrol ediniz.
|