UpdateOrdersResponse registerRefunds(
CPAuth auth,
CPRefund[] refunds
);
Input
Parameter | Type | Optional | Comment |
auth | CPAuth | no | Authentication data |
refunds | CPRefund[] | no | A list of refunds. Maximum of 100 per request! |
Output
Method returns an "UpdateOrdersResponse".
Description
With this call, you can register refunds with Channel Pilot Pro. It could be useful to refund a special amount for an order.
Example (SOAP-UI)
Request
In (example for a delayed shipping)
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v4="http://v4_2.seller.api.channelpilot.com/">
<soapenv:Header/>
<soapenv:Body>
<v4:registerRefunds>
<auth>
<merchantId>xxxxxxxxxx</merchantId>
<shopToken>xxxxxxxxxx</shopToken>
</auth>
<refunds>
<!--Zero or more repetitions:-->
<item>
<orderHeader>
<orderId>12345678</orderId>
<orderIdExternal>TEST_ORDER_531_3</orderIdExternal>
<source>ebay.de</source>
</orderHeader>
<refundTime>2019-02-07T13:42:30+01:00</refundTime>
<refund>
<net>100</net>
<gross>119</gross>
<tax>19</tax>
</refund>
</item>
</refunds>
</v4:registerRefunds>
</soapenv:Body>
</soapenv:Envelope>
Response
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:registerRefundsResponse xmlns:ns1="http://v4_2.seller.api.channelpilot.com/">
<return>
<header>
<resultCode>200</resultCode>
<resultMessage/>
</header>
<updateResults>
<header>
<resultCode>200</resultCode>
<resultMessage/>
</header>
<orderHeader>
<orderId>12345678</orderId>
<orderIdExternal>TEST_ORDER_531_3</orderIdExternal>
<source>ebay.de</source>
<status>
<identifier>25</identifier>
<publicTitle>Teilweise Ausgeliefert</publicTitle>
<publicDescription>Die Bestellung wurde teilweise ausgeliefert. Möglicherweise wurde ein Teil auch bereits storniert</publicDescription>
<hasError>false</hasError>
</status>
<orderTime>2019-02-07T13:42:30+01:00</orderTime>
<isBusinessOrder>false</isBusinessOrder>
</orderHeader>
</updateResults>
</return>
</ns1:registerRefundsResponse>
</soap:Body>
</soap:Envelope>