API Documentation >> API 2.0 Main >> Order Management >> Filter Orders

Filter Orders

Allowed HTTP Methods

• GET - Returns a collection of orders specified by the actor parameter (buyer or seller) and the state parameter (bought, paid, sent, received, lost, cancelled). Only orders for the authenticated user are returned. You can specify parameters for start and maximum results returned. If the response would have more than 100 entities a 410 Gone is returned. In this case the start parameter (and pagination) becomes mandatory.

Resource Information

• Authentication - Required
• Response Format - XML or JSON
• Response Object - Order
• API Version - 1.0
• Resource URI - https://api.cardmarket.com/ws/v2.0/orders/:actor/:state[/:start]

Parameters

• actor
  • Actor of the order
  • Type: either integer or string
  • Mandatory
    • seller or 1
    • buyer or 2
• state
  • State of the order
  • Type: either integer or string
  • Mandatory
    • bought or 1
    • paid or 2
    • sent or 4
    • received or 8
    • lost or 32
    • cancelled or 128
• start
  • If specified, only 100 entities are returned starting from the number provided
  • Type: integer
  • Optional (becomes Mandatory if unpaginated request would return more than 100 entities)
  • See also: Partial Content Documentation

Example Request

1. Returns orders 101 to 200 (partial content), where the authenticated user is seller and that are marked as received (i.e. all completed orders)

GET https://api.cardmarket.com/ws/v2.0/orders/seller/received/101 or GET https://api.cardmarket.com/ws/v2.0/orders/1/8/101

---

2. Returns all orders, where the authenticated user is buyer and that are marked as sent

GET https://api.cardmarket.com/ws/v2.0/orders/buyer/sent or GET https://api.cardmarket.com/ws/v2.0/orders/2/4