Changes the status of a single order specified by the id parameter. Actions that can be taken via the API are: mark as sent, mark as received, cancel a order, request order cancellation, accept a requested order cancellation. Returns the new representation of the specified order. The status of the order can only be changed, when the authenticated user is buyer (mark as received, cancel paid order, request cancellation) or seller (mark as sent, cancel unpaid order, request cancellation). The action of accepting a cancellation request can only be performed, when the other actor requested the cancellation before.
When an order is requested for cancellation a reason must be passed.
When an order is cancelled by the seller (or a seller accepts a cancellation request), the seller can pass information, if the articles of the order can be relisted. Default value is false.
| Authentication | Required |
|---|---|
| Response Format | XML |
| HTTP Methods | PUT |
| Response Object | Order |
| Data Object | Action |
| API Version | 1.0 |
https://www.mkmapi.eu/ws/:user/:apikey/order/:id
| id | Mandatory |
|---|
Specifies the action to be taken:
<action>send</action> // Mark the order as sent <action>confirmReception</action> // Mark a sent order as received <action>cancel</action> // Cancel a order (if possible) <action>requestCancellation</action> // Request a cancellation <action>acceptCancellation</action> // Accept a cancellation request <reason /> <relist />
PUT https://www.mkmapi.eu/ws/someuser/someapikey/order/835314
<?xml version="1.0" encoding="UTF-8" ?>
<request>
<action>send</action>
</request>
PUT https://www.mkmapi.eu/ws/someuser/someapikey/order/835314
<?xml version="1.0" encoding="UTF-8" ?>
<request>
<action>requestCancelllation</action>
<reason>Articles were sold at the weekend.</reason>
</request>
PUT https://www.mkmapi.eu/ws/someuser/someapikey/order/835314
<?xml version="1.0" encoding="UTF-8" ?>
<request>
<action>cancel</action>
<relist>true</relist>
</request>