TRENDYOL PARTNER (MARKETPLACE) API REFERANS DÖKÜMANI

Transkript

1 TRENDYOL PARTNER (MARKETPLACE) API REFERANS DÖKÜMANI v

2 İÇİNDEKİLER DÖKÜMAN REVİZYON BİLGİLERİ... 3 GİRİŞ... 4 API GÜVENLİĞİ... 4 TEST ORTAMI BİLGİLERİ... 4 CANLI ORTAM BİLGİLERİ... 4 METHODLAR... 6 ÜRÜN AKTARMA... 6 POST createproducts (Tekli Örnek)... 6 POST createproducts (Tek Ürün 2 Variant Örnek)... 7 AKTARILMIŞ ÜRÜN BİLGİSİ GÜNCELLEME ONAYLANAN ÜRÜNLERİN ALINMASI ÜRÜN STOK VE FİYAT BİLGİSİ GÜNCELLEME POST updatepriceandinventory TOPLU İŞLEM KONTROLÜ YAPILMASI SİPARİŞ PAKETLERİNİN ALINMASI FATURA KESME BİLDİRİMİ TEDARİK EDEMEME BİLDİRİMİ KARGO KODU DEĞİŞTİRME (YURTİÇİ KARGO)... 23

3 DÖKÜMAN REVİZYON BİLGİLERİ 1.4 Api adresleri düzenlendi 2.0 Canlı ortam bilgileri eklendi. Auth bilgileri eklendi 2.1 Ürün aktarım kontrol bilgileri eklendi. 3.0 Sipariş paketi çekme ile ilgili güncellemeler eklendi. 3.1 Yurtiçi Kargo kod değiştirme eklendi

4 GİRİŞ Trendyol Partner API, Trendyol Partner Programı na (MARKETPLACE) katılan firmaların yazılımsal olarak Ürün Gönderimi, Ürün Stok ve Fiyat Güncelleme işlemleri, Sipariş Bilgilerinin alınması işlemlerinin yapılmasına imkan sağlar. API GÜVENLİĞİ Trendyol Partner API ye yapılacak bütün isteklerde Basic Auth kullanılacaktır. Gönderilecek her isteğin Header bilgisinde Auth bilgisinin bulunması gerekmektedir. Bkz. Username ve password bilgisini adresine eposta atarak talep ediniz. TEST ORTAMI BİLGİLERİ Test ortamına erişebilmek için uygulama sunucularının IP bilgileri Trendyol tarafına bildirilerek erişim tanımı yapılmalıdır. Erişim tanımı sonrasında kullanılacak Supplier ID (Tedarikçi ID) bilgisi Trendyol tarafından sağlanacaktır. Bundan sonraki aşamalarda SupplierID olarak bu ID değeri kullanılacaktır. Tanımlama işlemi için adresine eposta gönderiniz. adresi üzerinden Swagger yardımıyla örnek istekte bulunulabilecektir. CANLI ORTAM BİLGİLERİ Canlı ortamına erişebilmek için uygulama sunucularının IP bilgileri Trendyol tarafına bildirilerek erişim tanımı yapılmalıdır. Erişim tanımı sonrasında kullanılacak Supplier ID (Tedarikçi ID) bilgisi Trendyol tarafından sağlanacaktır. Bundan sonraki aşamalarda SupplierID olarak bu ID değeri kullanılacaktır. Tanımlama işlemi için adresine eposta gönderiniz.

5 Canlı ortamda yapılacak bütün isteklerin adresine yapılması beklenmektedir.

6 METHODLAR ÜRÜN AKTARMA Ürünler Trendyol sistemine ilk olarak bu method yardımıyla iletilecektir. Tekli ve çoklu ürün gönderimini desteklemektedir. POST createproducts (Tekli Örnek) Content-Type application/json İSTEK

7 POST createproducts (Tek Ürün 2 Variant Örnek) Content-Type application/json İSTEK

8 "attributename":"beden", "attributevalue":"m" "attributename":"renk", "attributevalue":"kırmızı" ], "vatrate":18 "attributes": [ "attributename": "Yas Gurubu", "attributevalue": "16-26" "attributename": "Malzeme", "attributevalue": "Kauçuk" "attributename": "Theme", "attributevalue": "İlk Bahar Teması" ], "barcode":" ", "brand":"nike", "cargocompany":"yk", "categoryname":"ayakkabı", "currencytype":"mavi", "description":"trendyolmilla Ayakkabı", "gender":"m", "images":[ "url":" ], "listprice":120, "productmainid":"159357", "quantity":5, "saleprice":100, "stockcode":"a11b2c3d4", "title":"trendyolmilla Siyah Ayakkabi", "variantattributes":[ "attributename":"beden", "attributevalue":"m" "attributename":"renk", "attributevalue":"mavi" ], "vatrate":18 ], "supplierid": 1000 NOT: Bir ürünün birden fazla variant ı olması durumunda (Ürünün XL ve L bedeni gibi) çoklu örnek te olduğu şekliyle isteğin gönderilmesi beklenmektedir. variantattributes altında her bir variantattributes için (Örn: Renk) tek bir tane gönderilmesi gekir.

9 NOT 2: variantattributes alaninda Renk ve Beden dışında attributename gönderimi yapıldığında gönderilen ürünler Trendyol Ürün Yetkililerince görüntülenmemektedir. Parametre Açıklamaları *Koyu renkli belirtilmiş alanlar zorunlu alan olarak istekte gönderilmelidir Parameters product.brand product.barcode product.title product.description product.category.name product.listprice product.saleprice product.currencytype product.images. [List] product.vatrate product.shipmentfirm product.quantity Description Ürün markası Ürün Barkodu Ürün başlığı Ürün açıklama bilgileri (HTML olabilir) Ürün kategori adı Ürün liste fiyatı(satış fiyatı düşük olunca üstü çizilen fiyat) PSF Ürün satış fiyatı TSF Ürün liste fiyatı para birimi (TRY olacaktır.) Ürün resmi URL adresi Listesi/adresleri Ürün KDV oranı 0,1,8,18 gibi olmalı Ürün gönderileceği kargo firması Stok miktarı

10 product.productmainid product.attributes.designer product.attributes.modelsize product.attributes.project product.attributes.theme product.attributes.trendlevel product.gender product.variantattributes.beden product.variantattributes.renk Ana Ürün Kodu Tasarımcı Manken Ölçüsü Proje Tema Trend Seviye Cinsiyet Ürün beden bilgileri, L,XL,M, W32/L23 etc. Ürün rengi gönderilecektir. AKTARILMIŞ ÜRÜN BİLGİSİ GÜNCELLEME Create Products methodu upsert olarak çalışmakta ve eğer gönderilen barkod sistem içinde yok ise yaratma, eğer ilgili barkod için daha önceden gönderim yapıldıysa o barkod ile gelen ikinci istek sonrası gelen bilgilere göre diğer değerler güncellenmektedir. NOT: createproducts üzerinde yapılan güncelleme işlemleri Trendyol sistemindeki ham ürün datasını güncellemelektedir. Eğer göndermiş olduğunuz ürünler ile Trendyol üzerinde bir butik açılmış ise createproducts ile yapılan güncellemeler, satışta olan ürünlere yansımamaktadır. NOT: CreateProduct methodunda eğer fiyat ve stok değişimi gönderilirse bu değişiklikler canlı ortama yansımaktadır. ONAYLANAN ÜRÜNLERİN ALINMASI Trendyol a aktarılan ürünler, Trendyol tarafından yayına alınmadan önce kontrol edilerek onaylanır. Onaylanmış ürünler artık real-time stok ve fiyat güncellemelerini alabilecek statüdedir. GET filterproducts DÖNÜŞ

11 "id": "00042e917d80bacda81f7637e02365c8", "batchrequestid": "6cdcf f-8e45-92fdf0af924c", "supplierid": 1024, "createdatetime": , "lastupdatedate": , "lastpricechangedate": , "laststockchangedate": , "gender": "", "brand": "TRENDYOLMILLA", "barcode": " ", "title": "7983 Önü İşlemeli Boyfriend Pantolon-Mavi", "categoryname": "KOLEKSİYON > ALT GİYİM > PANTOLON", "description": "", "stockunittype": "Adet", "quantity": 2, "listprice": 30, "saleprice": 100, "vatrate": 8, "images": [ "url": " "url": " "url": " "url": " ], "attributes": [ ], "variantattributes": [ "attributename": "Renk", "attributevalue": "Mavi" "attributename": "Beden", "attributevalue": "36" ] "id": "4b5caac9a72f15677da077373d0ee393", "batchrequestid": "f0046af1-278f-4a2c-b6ef-ea2a9c4cdd31", "supplierid": 1024, "createdatetime": , "lastupdatedate": , "lastpricechangedate": , "laststockchangedate": , "gender": "", "brand": "TRENDYOLMILLA", "barcode": " ", "title": "2089 Arkası Fermuarlı Kazak-Ekru", "categoryname": "KOLEKSİYON > ÜST GİYİM > TRİKO", "description": "", "stockunittype": "Adet", "quantity": 20, "listprice": 100, "saleprice": 50, "vatrate": 8, "images": [

12 NOT: approved=false olarak sisteme yeni aktarılmış ürünler kontrol edilebilir. NOT: /products?approved=true&supplierid=supplierid&barcode=barkodvalue kullanarak TEK BİR barkodun onaylı olup olmadığını sorgulayabilirsiniz. ÜRÜN STOK VE FİYAT BİLGİSİ GÜNCELLEME Trendyol a aktarılan ve onaylanan ürünlerin fiyat ve stok bilgileri eş zamanlı olarak güncellenebilmektedir. POST updatepriceandinventory Content-Type application/json İSTEK

13 DÖNÜŞ HTTP 200 TOPLU İŞLEM KONTROLÜ YAPILMASI createproducts, updatepriceandinventory methodları servise yapılan istekler kuyruğa atarak işlendiği için, servise yapılan her başarlı istek sonucunda bir adet batchrequestid bilgisi dönülmektedir. Bu method yardımıyla batchrequestid ile alınan işlemlerin sonucunun kontrolü yapılabilir. Servis dönüşündeki "status" alanı control edilerek toplu işlemin tamamlanıp tamamlanmadığı kontrol edilebilir. Eğer toplu işlem sonucunda bir ya da birden fazla item için hata oluşmuş ise failurereasons alanı control edilerek sebebi bulunabilir. GET getbatchrequestresult DÖNÜŞ

14 "categoryname": "Üst Giyim", "listprice": 299.9, "saleprice": 209.9, "currencytype": "TRY", "vatrate": 18, "cargocompany": "YK", "quantity": 5, "stockcode": "a11b2c3d4", "images": [ "url": " ], "productmainid": "159357", "gender": null, "attributes": [], "variantattributes": [ "attributename": "Beden", "attributevalue": "XL" ] "status": "SUCCESS", "failurereasons": [] ], "status": "COMPLETED"

15 SİPARİŞ PAKETLERİNİN ALINMASI GET orders DÖNÜŞ

16 "vatbaseamount": 14.0, "barcode": " ", "orderlineitemstatusname": "Cancelled" "quantity": 1, "productid": , "salescampaignid": 15, "productsize": "M", "merchantsku": "6984", "productname": "Rustic Rubber Bacon", "productcode": 36407, "merchantid": 1024, "price": 3.0, "productcolor": "#630c21", "id": 2, "sku": "98273", "vatbaseamount": 15.0, "barcode": " ", "orderlineitemstatusname": "Cancelled" "quantity": 3, "productid": 30764, "salescampaignid": 15, "productsize": "M", "merchantsku": "110008", "productname": "Unbranded Concrete Pants", "productcode": 94022, "merchantid": 1024, "price": 167.0, "productcolor": "#7d4f4a", "id": 3, "sku": "119189", "vatbaseamount": 17.0, "barcode": " ", "orderlineitemstatusname": "Invoiced" ], "orderdate": , "tcidentitynumber": " ", "currencycode": "TRY" "shipmentaddress": "id": 4, "firstname": "Buçan", "lastname": "Arıcan", "company": "Beşok, Öztonga and Yıldızoğlu", "address1": "8655 Bulut Groves Apt. 517", "address2": "Apt. 361", "city": "West Beğboğa", "district": "4679 Günçiçek Courts", "postalcode": "29693", "countrycode": "TR", "fulladdress": "8655 Bulut Groves Apt. 517 Apt. 361" "ordernumber": " ", "totalprice": , "taxnumber": "23", "invoiceaddress": "id": 1, "firstname": "Bekbekeç", "lastname": "Yorulmaz", "company": "Ertürk and Sons", "address1": "4422 Akşit Union Apt. 872", "address2": "Apt. 088", "city": "New Baybüre", "district": "8483 Köylüoğlu Point", "postalcode": "12707", "countrycode": "TR",

17 "fulladdress": "4422 Akşit Union Apt. 872 Apt. 088" "customerfirstname": "Algu", "customerid": , "customerlastname": "Akgül", "id": 3, "cargotrackingnumber": null, "lines": [ "quantity": 3, "productid": 30764, "salescampaignid": 15, "productsize": "M", "merchantsku": "110008", "productname": "Unbranded Concrete Pants", "productcode": 94022, "merchantid": 1024, "price": 167.0, "productcolor": "#7d4f4a", "id": 3, "sku": "119189", "vatbaseamount": 17.0, "barcode": " ", "orderlineitemstatusname": "Invoiced" ], "orderdate": , "tcidentitynumber": " ", "currencycode": "TRY" "shipmentaddress": "id": 54, "firstname": "Bayunçur", "lastname": "Nebioğlu", "company": "Akbulut and Sons", "address1": "30267 Buyançuk Drives Apt. 309", "address2": "Apt. 616", "city": "New Baçaraberg", "district": "string", "postalcode": "35309", "countrycode": "AG", "fulladdress": "30267 Buyançuk Drives Apt. 309 Apt. 616" "ordernumber": " ", "totalprice": 0.00, "taxnumber": "29", "invoiceaddress": "id": 52, "firstname": "Güler", "lastname": "Tekelioğlu", "company": "Akman - Limoncuoğlu", "address1": "234 Arnaç View Apt. 224", "address2": "Suite 479", "city": "East Güvercinburgh", "district": "string", "postalcode": "10004", "countrycode": "QA", "fulladdress": "234 Arnaç View Apt. 224 Suite 479" "customerfirstname": "Andarıman", "customerid": 89494, "customerlastname": "Baykam", "id": 4, "cargotrackingnumber": null, "lines": [ "quantity": 8, "productid": 91262, "salescampaignid": 299, "productsize": null,

18 "merchantsku": "186665", "productname": "Handmade Steel Pants", "productcode": , "merchantid": 1024, "price": 731.0, "productcolor": null, "id": 52, "sku": "151104", "vatbaseamount": 16.0, "barcode": "123123", "orderlineitemstatusname": "Cancelled" "quantity": 8, "productid": 85540, "salescampaignid": 299, "productsize": null, "merchantsku": "109890", "productname": "Generic Frozen Pizza", "productcode": , "merchantid": 1024, "price": 958.0, "productcolor": null, "id": 53, "sku": "186942", "vatbaseamount": 12.0, "barcode": "456789", "orderlineitemstatusname": "Cancelled" ], "orderdate": , "tcidentitynumber": " ", "currencycode": "TRY" "shipmentaddress": "id": 57, "firstname": "Bayunçur", "lastname": "Nebioğlu", "company": "Akbulut and Sons", "address1": "30267 Buyançuk Drives Apt. 309", "address2": "Apt. 616", "city": "New Baçaraberg", "district": "string", "postalcode": "35309", "countrycode": "AG", "fulladdress": "30267 Buyançuk Drives Apt. 309 Apt. 616" "ordernumber": " ", "totalprice": , "taxnumber": "29", "invoiceaddress": "id": 55, "firstname": "Güler", "lastname": "Tekelioğlu", "company": "Akman - Limoncuoğlu", "address1": "234 Arnaç View Apt. 224", "address2": "Suite 479", "city": "East Güvercinburgh", "district": "string", "postalcode": "10004", "countrycode": "QA", "fulladdress": "234 Arnaç View Apt. 224 Suite 479" "customerfirstname": "Andarıman", "customerid": 89494, "customerlastname": "Baykam", "id": 5, "cargotrackingnumber": , "lines": [

19 "quantity": 8, "productid": 91262, "salescampaignid": 299, "productsize": null, "merchantsku": "186665", "productname": "Handmade Steel Pants", "productcode": , "merchantid": 1024, "price": 731.0, "productcolor": null, "id": 54, "sku": "151104", "vatbaseamount": 16.0, "barcode": "123123", "orderlineitemstatusname": "ReadyToShip" "quantity": 8, "productid": 85540, "salescampaignid": 299, "productsize": null, "merchantsku": "109890", "productname": "Generic Frozen Pizza", "productcode": , "merchantid": 1024, "price": 958.0, "productcolor": null, "id": 55, "sku": "186942", "vatbaseamount": 12.0, "barcode": "456789", "orderlineitemstatusname": "ReadyToShip" ], "orderdate": , "tcidentitynumber": " ", "currencycode": "TRY" "shipmentaddress": "id": 61, "firstname": "Arı", "lastname": "Akal", "company": "Türkdoğan LLC", "address1": "817 Balakatay Motorway Suite 341", "address2": "Apt. 813", "city": "West Alpyörük", "district": "706 Kulaksızoğlu Street", "postalcode": "10736", "countrycode": "TR", "fulladdress": "817 Balakatay Motorway Suite 341 Apt. 813" "ordernumber": " ", "totalprice": , "taxnumber": "31", "invoiceaddress": "id": 58, "firstname": "Engin", "lastname": "Kurutluoğlu", "company": "Taşçı and Sons", "address1": "3457 Atsız Row Apt. 269", "address2": "Apt. 628", "city": "South Çağrıteginfort", "district": "8868 Beğdurmuş Knolls", "postalcode": "18465", "countrycode": "TR", "fulladdress": "3457 Atsız Row Apt. 269 Apt. 628" "customerfirstname": "Ayma", "customerid": 59488,

20 ], "customerlastname": "Durak ", "id": 6, "cargotrackingnumber": , "lines": [ "quantity": 2, "productid": 55829, "salescampaignid": 15, "productsize": "M", "merchantsku": "117415", "productname": "Handmade Plastic Bacon", "productcode": 59528, "merchantid": 1024, "price": 980.0, "productcolor": "#387352", "id": 56, "sku": "194897", "vatbaseamount": 8.0, "barcode": " ", "orderlineitemstatusname": "ReadyToShip" "quantity": 1, "productid": 96622, "salescampaignid": 15, "productsize": "M", "merchantsku": "181862", "productname": "Intelligent Frozen Table", "productcode": 17583, "merchantid": 1024, "price": 289.0, "productcolor": "#0c0d76", "id": 57, "sku": "47178", "vatbaseamount": 14.0, "barcode": " ", "orderlineitemstatusname": "ReadyToShip" ], "quantity": 3, "productid": , "salescampaignid": 15, "productsize": "M", "merchantsku": "11994", "productname": "Incredible Rubber Computer", "productcode": 71928, "merchantid": 1024, "price": 164.0, "productcolor": "#385867", "id": 58, "sku": "136674", "vatbaseamount": 10.0, "barcode": " ", "orderlineitemstatusname": "ReadyToShip" "orderdate": , "tcidentitynumber": " ", "currencycode": "TRY" "totalelements": 5 NOT 1: Sipariş datası alınırken gelen ordernumber değeri o siparişin Trendyol sistemindeki ana sipariş numarasına karşılık gelmektedir. Aynı seviyede yer alan id değeri de o sipariş numarasına karşılık oluşturulmuş Sipariş Paketini temsil etmektedir.

21 NOT 2: Herhangi bir sipariş paketi içinde bir ya da birden fazla kalem İptal edilir ise, Sistem tarafından otomatik olarak ordernumber aynı kalmak koşuluyla sipariş paketi bozulur ve yeni bir id değeri ve kargo barkodu oluşturulur. NOT 3: Sipariş bilgilerinin çekelerken ürünün createproducts ile gönderilen Barkod değelerine göre paketleme ve işlemler yapılmalıdır. NOT 4: Trendyol.com da bir müşteri birden fazla butikten ürün alır ise aynı ordernumber altında birden fazla paket oluşabilir. Bu sebeple, geliştirme yapılırken bir ordernumber altından her zaman birden fazla id (paketid) gelecek şekilde işlem yapılmalıdır. NOT 5: suppliers/xxxx/orders?status=created gibi bir query ile de paket statülerine göre sorgulama yapılabilir. Kullanılabilinecek statüler: Created, Picking, Invoiced, Shipped, Cancelled, Delivered, UnDelivered, Returned, Repack, UnSupplied (Sistemde paket statüleri ve orderlineitem statüleri birbirinden farklıdır.) Yeni oluşmuş paketleri çekmek için Created olarak sorgulama yapılmalıdır. FATURA KESME BİLDİRİMİ Oluşturularan sipariş paketinin faturasının kesilmesi işleminin Trendyol a bildirilebilmesi için kullanılır. Fatura kesme işleminin bildirilmesi, Trendyol Müşteri Hizmetlerine ulaşan, müşteri kaynaklı iptallerin önlenmesi için bir referanstır. PUT updatepackage Content-Type application/json İSTEK

22 DÖNÜŞ HTTP 200 TEDARİK EDEMEME BİLDİRİMİ Tedarikçinin paket içerisindeki ürünlerden bir ya da birkaçını Tedarik Edememe kaynaklı iptal etmesi için kullanılır. Bu method yardımıyla yapılan bir iptal sonrası, iptal edilen paket bozularak yeni ID li bir paket oluşturulacaktır. ÖNEMLİ NOT: Tedarik edememe bildirimi yapıldıktan sonra Trendyol Order Management System tarafından aynı ordernumber üzerinde yeni bir ShipmentPackageID oluşturulmakta ve daha önceki shipmentpackage iptal edilmektedir. Bu durumda Tedarik Edememe kaydı yapıldıktan sonra tekrar Sipariş Paketlerinin Alınması işlemi yapılması gerekmektedir. PUT updatepackage Content-Type application/json İSTEK DÖNÜŞ HTTP 200 NOT : Her tedarik edememe bildirimi sonrasında, Sistem tarafından otomatik olarak ordernumber aynı kalmak koşuluyla sipariş paketi bozulur ve yeni bir id değeri ve kargo barkodu oluşturulur.

23 Bu sebeple Orders method çağırılarak yeni oluşan id değerine göre paket operasyonları yapılmalıdır. KARGO KODU DEĞİŞTİRME (YURTİÇİ KARGO) Tedarikçinin Yurtiçi Kargo firmasından kendi anlaşması üzerinden gönderdiği ürünün, Trendyol sistemine bildirilmesi için kullanılır. Bu method herhangi bir paket için çağırıldığında, artık Trendyol un Yurtiçi Kargo anlaşması üzerinden olan paket değil, tedarikçinin kendi anlaşması üzerinden yaptığı gönderinin durumu sorgulanmaya başlar ve Yola Çıktı, Teslim Edildi, Teslim Edilemedi bilgileri entegrasyon üzerinden alınır ve takip edilir. ÖNEMLİ NOT: Sadece Yurtiçi Kargo paketleri için bu işlem kullanılabilir olup, Yola Çıkmış, Teslim Edilmiş statüdeki paketler için kargo kodu kullanılamaz. EĞer ÖNEMLİ NOT2: Eğer kargo numarası update edilen bir pakete tedarik edememe bildirimi yapılırsa, yeni bir paket ve kargo kodu oluşacağı için entegrasyon üzerinden yeni oluşacak paketin de tekrar kargo kodunun güncellenmesi beklenir. PUT updatepackage Content-Type application/json İSTEK DÖNÜŞ HTTP 200 DÖNÜŞ HATA

24 "timestamp": , "exception": "ClientApiBusinessException", "errors": [ "key": "shipment.package.tracking.number.could.not.updated", "message": "Sipariş kargo paketinin numaralı kargo kodu güncellenemedi. Hata: Gecersiz kargo kodu, Kargo Id: ", ] "args": [ ] " ", Gecersiz kargo kodu, " "