UpdateOrdersResponse setPaidOrders(
CPAuth auth,
CPOrder[] paidOrders
);
Input
Parameter | Type | Optional | Comment |
auth | CPAuth | no | Authentication data |
paidOrders | CPOrder[] | no | A list of paid orders. Maximum of 100 per request! |
Output
Method returns an UpdateOrdersResponse
Description
Some payment methods require a payment validation by the online shop.
For example, on ebay the customer could choose “DirectDebit” as a payment method. The order will be retrieved without a paymentTime (see CPPayment.paymentTime in GetNewMarketplaceOrdersResponse after getNewMarketplaceOrders). Because the ebay customer wants to know the payment status, you should use this call to notify Channel Pilot.
The paymentTime is not set, if the payment has not been fulfilled yet and has to be fulfilled by you! Each order that uses a payment method fulfilled by a channel gets a valid paymentTime.
If you don’t send any setPaidOrder-calls the orders will get the “isPaid” status during the registerDeliveries-call.
Fields
CPOrder.payment has to be set. If you don’t send a valid paymentTime or none at all, the current time will be used.
Example (SOAP-UI)
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v4="http://v4_2.seller.api.channelpilot.com/">
<soapenv:Header/>
<soapenv:Body>
<v4:setPaidOrders>
<auth>
<merchantId>xxxxxxxxxx</merchantId>
<shopToken>xxxxxxxxxx</shopToken>
</auth>
<paidOrders>
<!--Zero or more repetitions:-->
<item>
<orderHeader>
<orderId>12345678</orderId>
<orderIdExternal>TEST_ORDER_531_3</orderIdExternal>
<source>ebay.de</source>
</orderHeader>
<payment>
<paymentTime>2019-02-07T13:42:30+01:00</paymentTime>
</payment>
</item>
</paidOrders>
</v4:setPaidOrders>
</soapenv:Body>
</soapenv:Envelope>
Response
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:setPaidOrdersResponse xmlns:ns1="http://v4_2.seller.api.channelpilot.com/">
<return>
<header>
<resultCode>200</resultCode>
<resultMessage/>
</header>
</return>
</ns1:setPaidOrdersResponse>
</soap:Body>
</soap:Envelope>