UpdateOrdersResponse registerCancellations(
CPAuth auth,
CPCancellation[] cancellations
);
Input
Parameter | Type | Optional | Comment |
auth | CPAuth | no | Authentication data |
cancellations | CPCancellation[] | no | A list of cancellations. Maximum of 100 per request! |
Output
Method returns an UpdateOrdersResponse
Description
With this call you can register cancellations with Channel Pilot Pro. A customer’s return is also treated as cancellation. It could be a full cancellation or a partial cancellation. If all items are cancelled in a partial cancellation, Channel Pilot Pro automatically treats this call as fullcancellation.
Fields
For a complete cancellation, set CPCancellation.isWholeOrderCancelled to true. For a partial cancellation, set this to false and send cancelledItems
Examples (SOAP-UI)
Full cancellation
Request
<soap:Envelope xmlns:soap=http://schemas.xmlsoap.org/soap/envelope/ xmlns:v4="http://v4_2.seller.api.channelpilot.com/">
<soapenv:Header/>
<soap:Body>
<v4:registerCancellations>
<auth>
<merchatId>xxxxxxxxxx</merchantId>
<shopToken>xxxxxxxxxx</shopToken>
</auth>
<cancellations>
<item>
<orderHeader>
<orderId>1234567</orderId>
<orderIdExternal>TEST_ORDER_531_2</orderIdExternal>
<source>ebay.de</source>
</orderHeader>
<cancellationTime>2019-02-06T14:00:00+02:00</cancellationTime>
<isWholeOrderCancelled>1</isWholeOrderCancelled>
</item>
</cancellations>
</v4:registerCancellations>
</soapenv:Body>
</soapenv:Envelope>
Response
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:registerCancellationsResponse 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>1234567</orderId>
<orderIdExternal>TEST_ORDER_531_2</orderIdExternal>
<source>ebay.de</source>
<status>
<identifier>99</identifier>
<publicTitle>Storniert</publicTitle>
<publicDescription>Bestellung wurde storniert</publicDescription>
<hasError>false</hasError>
</status>
<orderTime>2019-02-07T12:59:03+01:00</orderTime>
<isBusinessOrder>false</isBusinessOrder>
</orderHeader>
</updateResults>
</return>
</ns1:registerCancellationsResponse>
</soap:Body>
</soap:Envelope>
Partial cancellation
Request
<soap:Envelope xmlns:soap=http://schemas.xmlsoap.org/soap/envelope/ xmlns:v4="http://v4_2.seller.api.channelpilot.com/">
<soapenv:Header/>
<soap:Body>
<v4:registerCancellations>
<auth>
<merchatId>xxxxxxxxxx</merchantId>
<shopToken>xxxxxxxxxx</shopToken>
</auth>
<cancellations>
<item>
<orderHeader>
<orderId>1234567</orderId>
<orderIdExternal>TEST_ORDER_531_2</orderIdExternal>
<source>ebay.de</source>
</orderHeader>
<cancellationTime>2019-02-06T14:00:00+02:00</cancellationTime>
<isWholeOrderCancelled>0</isWholeOrderCancelled>
<cancelledItems>
<id>SW10013</id>
<idExternal>TEST_ORDER_531_2_ITEM_1</idExternal>
<quantityOrdered>2</quantityOrdered>
<quantityDelivered>0</quantityDelivered>
<quantityCancelled>1</quantityCancelled>
</cancelledItems>
</item>
</cancellations>
</v4:registerCancellations>
</soapenv:Body>
</soapenv:Envelope>
Response
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:registerCancellationsResponse 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>1234567</orderId>
<orderIdExternal>TEST_ORDER_531_2</orderIdExternal>
<source>ebay.de</source>
<status>
<identifier>20</identifier>
<publicTitle>Importiert</publicTitle>
<publicDescription>Bestellung wurde in den Shop importiert </publicDescription>
<hasError>false</hasError>
</status>
<orderTime>2019-02-07T12:59:03+01:00</orderTime>
<isBusinessOrder>false</isBusinessOrder>
</orderHeader>
</updateResults>
</return>
</ns1:registerCancellationsResponse>
</soap:Body>
</soap:Envelope>