SoapAPI İade Talepleri Servisi (ReturnService)
Sipariş İade Talepleri Servisi
Sipariş İade Talepleri servisi için WSDL adresi: https://api.n11.com/ws/ReturnService.wsdl
Bu servise dahil olan methodlar, parametrelerin listesi ve detaylı dökümantasyonu aşağıda yer almaktadır.
- İade Talepleri Listeleme (ClaimReturnList)
- İade Talebi Ret Sebepleri Listeleme (ClaimReturnDenyReasonType)
- İade Talebi Erteleme Sebepleri Listeleme (ClaimReturnPendingReasonType)
- İade Talebi Onaylama (ClaimReturnApprove)
- İade Talebi Erteleme (ClaimReturnPending)
- İade Talebi Reddetme (ClaimReturnDeny)
İade Talepleri Listeleme (ClaimReturnList)
Mağazaya gelen sipariş iade taleplerini liste halinde yollayan servis. Her sayfada 20 iade bilgisi gelir
- API bilgileri haricinde zorunlu parametre bulunmamaktadır.
Dikkat Edilmesi Gerekenler;
- searchData.status alanı boş ya da alabileceği parametre değerleri dışında bir değer gönderilmesi durumunda default olarak REQUESTED statülü iade talepleri listelenmektedir.
Parametre | Parametre Değer | Açıklama |
Auth.appKey | API Key | |
Auth.appSecret | API Secret | |
searchData.status | “ REQUESTED”: İade Talebi Geldi “ CANCELLED”: İptal Edildi “ DENIED”: Reddedildi “ PENDING”: Erteleme Talep Edildi “ PENDED”: Değerlendirme Ertelendi “ APPROVED”: İade Onaylandı “ MANUAL_REFUND” : Manuel Para İadesi Tamamlandı “ ALL”: Bütün iade durumları |
Sipariş iade talep durumu |
searchData.executer | “ BUYER”: Alıcı “ SELLER”: Satıcı “ OPERATOR”: Operatör “ SYSTEM”: Sistem “ SHIPMENT”: Kargo Şirketi |
İşlemi yapan bilgisi |
searchData.searchInfoType | “ BUYEREMAIL”: Alıcı Mail Adresi “ RECIPIENTS”: Teslim Alan “ BUYERNAME”: Alıcı Adı Soyadı “ ORDERID”: Sipariş Kodu “ PRODUCTID”: Ürün Kodu |
İade talebi detayı aramada searchData.searchQuery ile arama yapılacaksa gönderilmelidir, arama detayı tipini belirtir. |
searchData.searchQuery | searchData.searchInfoType ‘ a göre arama yapılmak istenen kelime / kod. | |
searchData.period . startDate | İade talebi gelme tarihi başlangıç. (dd/mm/yyyy) | |
searchData.period . endDate | İade talebi gelme tarihi bitiş. (dd/mm/yyyy) | |
currentPage | Gösterilen sayfa numarası (currentpage 0 ile başlar). |
Parametre (Cevap) | Açıklama |
result.status | İşlem sonucu durum bilgisini gösterir. “success” ya da “failure” durum bilgilerini döner. |
claimReturnList.claimReturn.claimReturnId | İade talep idsi. |
claimReturnList.claimReturn.status | İade durumu. |
claimReturnList.claimReturn.executer | İşlemi yapan bilgisi. |
claimReturnList.claimReturn.returnReasonType | İade nedeni. |
claimReturnList.claimReturn.returnReasonDescription | İade açıklaması. |
claimReturnList.claimReturn.orderNumber | Sipariş kodu. |
claimReturnList.claimReturn.sellerCampaignNumber | Mağaza Gönderi Kampanya No. |
claimReturnList.claimReturn.shipmentMethod | Teslimat Metodu. |
claimReturnList.claimReturn.bundleName | Kampanya Adı (Var ise) |
claimReturnList.claimReturn.requestDate | Talep Tarihi. |
claimReturnList.claimReturn.pendingRequestDate | Erteleme Talep Tarihi. |
claimReturnList.claimReturn.pendedDate | Erteleme Tarihi. |
claimReturnList.claimReturn.cancelledDate | İadeTarihi. |
claimReturnList.claimReturn.deniedDate | Ret Tarihi. |
claimReturnList.claimReturn.approvedDate | Onay Tarihi. |
claimReturnList.claimReturn.sellerShipmentCompany | Mağaza Gönderi Kargo Şirketi. |
claimReturnList.claimReturn.sellerTrackingNumber | Mağaza Gönderi Takip No. |
claimReturnList.claimReturn.productId | Ürün Kodu. |
claimReturnList.claimReturn.productName | Ürün Adı. |
claimReturnList.claimReturn.attributesNames | Ürün Özelliği. |
claimReturnList.claimReturn.quantity | İade talebi yapılan ürün adedi. |
claimReturnList.claimReturn.unitPrice | Birim Fiyatı. |
claimReturnList.claimReturn.finalPrice | Ödenen Tutar. |
claimReturnList.claimReturn.shipmentCompany | Kargo Şirketi. |
claimReturnList.claimReturn.trackingNumber | Kargo Takip No. |
claimReturnList.claimReturn.campaignNumber | Kampanya No. |
claimReturnList.claimReturn.deliveryFeeType | Kargo Ücretinin kimin tarafından ödendiği bilgisi; ‘ByBuyer’ Alıcı Öder ‘BySeller’ Mağaza Öder ‘Conditional’ Şartlı Kargo |
claimReturnList.claimReturn.buyerPhone | Müşterinin Telefon Numarası |
claimReturnList.claimReturn.buyerEmail | Müşterinin Email Adresi |
claimReturnList.claimReturn.buyerName | Müşterinin Adı Soyadı |
claimReturnList.claimReturn.paymentDate | Ödeme Tarihi |
pagingData.currentPage | Gösterilen sayfa numarası (currentpage 0 ile başlar) |
pagingData.pageSize | Sayfadaki madde sayısı |
pagingData.totalCount | Toplam madde sayısı |
pagingData.pageCount | Toplam sayfa sayısı |
Örnek Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sch="http://www.n11.com/ws/schemas">
<soapenv:Header/>
<soapenv:Body>
<sch:ClaimReturnListRequest>
<auth>
<appKey>***********</appKey>
<appSecret>****</appSecret>
</auth>
<searchData>
<status>ALL</status>
<executer></executer>
<searchInfoType>ORDERID</searchInfoType>
<searchQuery>123456789</searchQuery>
<period>
<startDate></startDate>
<endDate></endDate>
</period>
</searchData>
<pagingData>
<currentPage></currentPage>
</pagingData>
</sch:ClaimReturnListRequest>
</soapenv:Body>
</soapenv:Envelope>
Örnek Response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<ns3:ClaimReturnListResponse xmlns:ns3="http://www.n11.com/ws/schemas">
<result>
<status>success</status>
</result>
<claimReturnList>
<claimReturn>
<attributesNames/>
<buyerEmail>****@gmail.com</buyerEmail>
<buyerName>ad soyad</buyerName>
<buyerPhone>55*****</buyerPhone>
<claimReturnId>12345</claimReturnId>
<deliveryFeeType>BySeller</deliveryFeeType>
<finalPrice>100</finalPrice>
<orderNumber>123456789</orderNumber>
<paymentDate>12/09/2019</paymentDate>
<productId>1234</productId>
<productName>Sürat Poplu Ürün</productName>
<quantity>1</quantity>
<requestDate>16/09/2019</requestDate>
<returnReasonDescription>deneme</returnReasonDescription>
<returnReasonType>Farklı ürün ulaştı</returnReasonType>
<sellerTrackingNumber/>
<shipmentCompany>Sürat</shipmentCompany>
<shipmentMethod>Shipping</shipmentMethod>
<status>REQUESTED</status>
<trackingNumber>4134</trackingNumber>
<unitPrice>100</unitPrice>
</claimReturn>
<pagingData>
<currentPage>0</currentPage>
<pageSize>20</pageSize>
<totalCount>1</totalCount>
<pageCount>1</pageCount>
</pagingData>
</ns3:ClaimReturnListResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
İade Talebi Ret Sebepleri Listeleme (ClaimReturnDenyReasonType)
Ret sebeplerini listeleyen servis. İade talebi ret servisinde (ClaimReturnDenyRequest) kullanılacaktır.
- API bilgileri haricinde zorunlu parametre bulunmamaktadır.
Parametre | Açıklama |
Auth.appKey | API Key |
Auth.appSecret | API Secret |
Parametre (Cevap) | Açıklama |
result.status | İşlem sonucu durum bilgisini gösterir. “success” ya da “failure” durum bilgilerini döner. |
pendingReasonTypeDataList.id | Erteleme sebebi idsi. |
pendingReasonTypeDataList.value | Erteleme sebebi açıklaması. |
Örnek Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sch="http://www.n11.com/ws/schemas">
<soapenv:Header/>
<soapenv:Body>
<sch: ClaimReturnDenyReasonTypesRequest>
<auth>
<appKey>************************</appKey>
<appSecret>********</appSecret>
</auth>
</sch: ClaimReturnDenyReasonTypesRequest>
</soapenv:Body>
</soapenv:Envelope>
Örnek Response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<ns3:ClaimReturnDenyReasonTypesResponse xmlns:ns3="http://www.n11.com/ws/schemas">
<denyReasonTypeDataList>
<id>21</id>
<value>Özel Promosyonlu Ürün</value>
</denyReasonTypeDataList>
<denyReasonTypeDataList>
<id>1</id>
<value>Ürün kargoya sağlam teslim edildi</value>
</denyReasonTypeDataList>
<denyReasonTypeDataList>
<id>2</id>
<value>Ürün zarar görmüş</value>
</denyReasonTypeDataList>
<denyReasonTypeDataList>
<id>22</id>
<value>İptal ve İadesi kabul edilmeyen Ürün</value>
</denyReasonTypeDataList>
<denyReasonTypeDataList>
<id>23</id>
<value>Turun kalkış gününe son 24 saat kalması</value>
</denyReasonTypeDataList>
<denyReasonTypeDataList>
<id>3</id>
<value>Mevzuata Göre İadesi Kabul Edilmeyen Ürün</value>
</denyReasonTypeDataList>
<denyReasonTypeDataList>
<id>24</id>
<value>Turun kalkış gününe son 48 saat kalması</value>
</denyReasonTypeDataList>
<denyReasonTypeDataList>
<id>25</id>
<value>Turun kalkış gününe son 72 saat kalması</value>
</denyReasonTypeDataList>
<denyReasonTypeDataList>
<id>41</id>
<value>İade Ürün Mağazaya Ulaşmadı</value>
</denyReasonTypeDataList>
</ns3:ClaimReturnDenyReasonTypesResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
İade Talebi Erteleme Sebepleri Listeleme (ClaimReturnPendingReasonType)
Erteleme sebeplerini listeleyen servis. İade talebi erteleme servisinde (ClaimReturnPending) kullanılacaktır.
- API bilgileri haricinde zorunlu parametre bulunmamaktadır.
Parametre | Açıklama |
Auth.appKey | API Key |
Auth.appSecret | API Secret |
Parametre (Cevap) | Açıklama |
result.status | İşlem sonucu durum bilgisini gösterir. “success” ya da “failure” durum bilgilerini döner. |
denyReasonTypeDataList.id | Ret sebebi idsi. |
denyReasonTypeDataList.value | Ret sebebi açıklaması. |
Örnek Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sch="http://www.n11.com/ws/schemas">
<soapenv:Header/>
<soapenv:Body>
<sch: ClaimReturnPendingReasonTypesRequest>
<auth>
<appKey>************************</appKey>
<appSecret>********</appSecret>
</auth>
</sch: ClaimReturnPendingReasonTypesRequest>
</soapenv:Body>
</soapenv:Envelope>
Örnek Response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<ns3:ClaimReturnPendingReasonTypesResponse xmlns:ns3="http://www.n11.com/ws/schemas">
<pendingReasonTypeDataList>
<id>1</id>
<value>Ürün servis tarafından incelenecek</value>
</pendingReasonTypeDataList>
<pendingReasonTypeDataList>
<id>21</id>
<value>Ürün acente tarafından incelenecek</value>
</pendingReasonTypeDataList>
<pendingReasonTypeDataList>
<id>2</id>
<value>Ürün fabrika tarafından incelenecek</value>
</pendingReasonTypeDataList>
<pendingReasonTypeDataList>
<id>3</id>
<value>Gerekli kontroller yapılacak</value>
</pendingReasonTypeDataList>
</ns3:ClaimReturnPendingReasonTypesResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
İade Talebi Onaylama (ClaimReturnApprove)
İade talebini onaylama servisi.
- Tüm request parametreleri zorunludur.
Parametre | Açıklama |
Auth.appKey | API Key |
Auth.appSecret | API Secret |
claimReturnId | Onaylanacak iade talebinin idsi. |
Parametre (Cevap) | Açıklama |
result.status | İşlem sonucu durum bilgisini gösterir. “success” ya da “failure” durum bilgilerini döner. |
Örnek Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sch="http://www.n11.com/ws/schemas">
<soapenv:Header/>
<soapenv:Body>
<sch: ClaimReturnApproveRequest >
<auth>
<appKey>************************</appKey>
<appSecret>********</appSecret>
</auth>
<claimCancelId>1234567</claimCancelId>
</sch: ClaimReturnApproveRequest >
</soapenv:Body>
</soapenv:Envelope>
Örnek Response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<ns3: ClaimReturnApproveResponse xmlns:ns3="http://www.n11.com/ws/schemas">
<result>
<status>success</status>
</result>
</ns3: ClaimReturnApproveResponse >
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
İade Talebi Erteleme (ClaimReturnPending)
İade talebini ertleme servisi.
- Tüm request parametreleri zorunludur.
Parametre | Açıklama |
Auth.appKey | API Key |
Auth.appSecret | API Secret |
claimReturnlId | Ertelenecek iade talebinin idsi. |
pendingReasonId | Ertleme sebebinin idsi. ClaimReturnPendingReasonType servisinden alınacaktır. |
pendingDayCount | Erteleme Gün Sayısı. |
pendingReasonNote | Erteleme Açıklaması. |
Parametre (Cevap) | Açıklama |
result.status | İşlem sonucu durum bilgisini gösterir. “success” ya da “failure” durum bilgilerini döner. |
Örnek Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sch="http://www.n11.com/ws/schemas">
<soapenv:Header/>
<soapenv:Body>
<sch:ClaimReturnPendingRequest>
<auth>
<appKey>************************</appKey>
<appSecret>********</appSecret>
</auth>
<claimReturnId>123456789</claimReturnId>
<pendingReasonId>123</pendingReasonId>
<pendingDayCount>1</pendingDayCount>
<pendingReasonNote>açıklama</pendingReasonNote>
</sch:ClaimReturnPendingRequest>
</soapenv:Body>
</soapenv:Envelope>
Örnek Response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<ns3: ClaimReturnPendingResponse xmlns:ns3="http://www.n11.com/ws/schemas">
<result>
<status>success</status>
</result>
</ns3: ClaimReturnPendingResponse >
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
İade Talebi Reddetme (ClaimReturnDeny)
İade talebini reddetme servisi.
- API bilgileri, claimReturnlId, denyReasonId, denyReasonNote parametreleri zorunludur.
Dikkat Edilmesi Gerekenler;
- returnShipmentType alanı Aynı Gün Teslimat, Özel Teslimat ve Bilet siparişlerinin iade taleplerinin reddinde bu alan boş bırakılmalıdır.
- İade ret sebebi “Ürün Mağazaya Ulaşmadı” ise returnShipmentType alanı boş bırakılmalıdır. Alıcının talep için girmiş olduğu takip numarası otomatik olarak gönderilecektir.
- “Ürün Mağazaya Ulaşmadı” harici ret sebeplerinde returnShipmentType alanı CUSTOM gönderilirse, ürünü kargoya verdikten sonra trackingNumber alanında kargo takip numarasını göndermeniz gerekmektedir.
- “Ürün Mağazaya Ulaşmadı” harici ret sebeplerinde returnShipmentType alanı CAMPAIGN gönderilirse, shipmentCompanyId , trackingNumber , deliveryReceiptNumber alanları boş bırakılmalıdır. Ürünü iade için henüz kargoya vermediyseniz kampanya kodu kullanarak belirtilen kargo şirketi ile gönderdiğinizde, takip kodu sisteme otomatik olarak tanımlanır, ve iade talebiniz otomatik olarak onaylanmış olur. Onayladığınız takdirde ürünler için üretilecek olan kargo kampanya kodlarına claimReturnList metodundaki sellerCampaignNumber yani "Mağaza Gönderi Kampanya No" alanından ulaşabilirsiniz.
- returnShipmentType “CUSTOM” ve Ret sebebi “Ürün Mağazaya Ulaşmadı” değil ise, diğer durumlar için trackingNumber ve shipmentCompanyId alanları boş bırakılmalıdır.
- Aynı Gün Teslimat, Özel Teslimat ve Bilet siparişlerinin iade taleplerinin reddinde deliveryReceiptNumber alanı zorunludur. Diğer durumlar için bu alan boş bırakılmalıdır.
Parametre | Parametre Değer | Açıklama |
Auth.appKey | API Key | |
Auth.appSecret | API Secret | |
claimReturnlId | Reddelilecek iade talebinin idsi. | |
denyReasonId | Reddelilecek sebebinin idsi. ClaimReturnDenyReasonType servisinden alınmalıdır. | |
denyReasonNote | Ret sebebi açıklaması | |
returnShipmentType | " CUSTOM" = Takip Numarası İle " CAMPAIGN" = Kargo Kampanyası İle |
Gönderim Tipi. |
shipmentCompanyId | Kargo şirketi Idsi. ShipmentCompanyService servisinden alınmalıdır. | |
trackingNumber | Takip Numarası. | |
deliveryReceiptNumber | Teslim Fiş No. |
Parametre (Cevap) | Açıklama |
result.status | İşlem sonucu durum bilgisini gösterir. “success” ya da “failure” durum bilgilerini döner. |
Örnek Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sch="http://www.n11.com/ws/schemas">
<soapenv:Header/>
<soapenv:Body>
<sch:ClaimReturnDenyRequest>
<auth>
<appKey>************************</appKey>
<appSecret>********</appSecret>
</auth>
<claimReturnId>123456789</claimReturnId>
<denyReasonId>123</denyReasonId>
<denyReasonNote>aynı gün teslimat iade talebi red</denyReasonNote>
<returnShipmentType></returnShipmentType>
<shipmentCompanyId></shipmentCompanyId>
<trackingNumber></trackingNumber>
<deliveryReceiptNumber>123456</deliveryReceiptNumber>
</sch:ClaimReturnDenyRequest>
</soapenv:Body>
</soapenv:Envelope>
Örnek Response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<ns3: ClaimReturnDenyResponsexmlns:ns3="http://www.n11.com/ws/schemas">
<result>
<status>success</status>
</result>
</ns3: ClaimReturnDenyResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>