API Documentation >> API 2.0 Main >> Order Management >> Order

Order

Allowed HTTP Methods

• GET - Returns an order specified by its ID.
• PUT - Changes the state of an order specified by its ID.

Resource Information

• Authentication - Required
• Request Object - Action
• Response Format - XML or JSON
• Response Object - Order
• API Version - 1.0
• Resource URI - https://api.cardmarket.com/ws/v2.0/order/:idOrder

Parameters

• idOrder
  • Order ID
  • Type: integer
  • Mandatory

Request Object

<?xml version="1.0" encoding="UTF-8" ?>
<request>
    <action />                      // Action to be performed to change the state of the order
    <reason />                      // The reason for the cancellation request; only applicable, if action = requestCancellation
    <relistItems />                 // true|false, only applicable (and optional):
                                    // - if action = requestCancellation and the actor is the seller of the order, or
                                    // - if action = acceptCancellation and the actor is the seller of the order
</request>

Possible values for action:

• send - can be performed by the seller, if the current state is paid
• confirmReception - can be performed by the buyer, if the current state is sent
• cancel - can be performed by the seller, if the current state is bought for more than 7 days; can be performed by the buyer, if the current state is paid for more than 7 days
• requestCancellation - can be performed by both, if the state is not yet sent, the additional key reason is required; if the seller requests cancellation, an optional key relistItems can be provided to indicate, if the articles of the order should be relisted after the cancellation request was accepted by the buyer
• acceptCancellation - can be performed by both (but must be opposing actor), if the state is cancellationRequested; if the seller accepts the cancellation request, an optional key relistItems can be provided to indicate, if the articles of the order should be relisted thereafter

Example Request

1. Get details of an order:

GET https://api.cardmarket.com/ws/v2.0/order/2844597

---

2. Mark the order as sent:

PUT https://api.cardmarket.com/ws/v2.0/order/2844597

<?xml version="1.0" encoding="UTF-8" ?>
<request>
    <action>send</action>
</request>

---

3. Seller requests cancellation of the order:

PUT https://api.cardmarket.com/ws/v2.0/order/2844597

<?xml version="1.0" encoding="UTF-8" ?>
<request>
    <action>requestCancellation</action>
    <reason>Don't have the articles anymore</reason>
    <relistItems>false</relistItems>
</request>