Skip to content

XBID Order Status v1

The XBID Order Status v1 provides endpoints to retrieve both the history and current status of XBID orders and baskets. It supports filtering by orderId or basketId and requires an API key for authentication. Responses include detailed order status entries or lists, with proper handling of cases where no matching records are found.

Operations

Get History of the XBID Order Status by orderId

Request

Get history of the order status with filtering by orderId that creating on POST/PUT order requests.

Security
api-key
Path
idstringrequired
GET
/public-api/1.0/xbid/orders/status/{id}
curl -i -X GET \
  'https://acc-trading.etpa.nl/public-api/1.0/xbid/orders/status/{id}' \
  -H 'api_key: YOUR_API_KEY_HERE'

Responses

Order status entry

Bodyapplication/json
orderIdobject(OrderId)required

The orderId is created by Order api as a response from put/post order requests.

basketIdobject(BasketId)

The id of the Basket order.

individualIdstringrequired

Identifier of the individual that created the order.

participantIdstringrequired

The participant identifier of the participant to which the order belongs.

currentStatusobject(XbidOrderStatusItem)required

The last situation of order.

historyArray of objects(XbidOrderStatusItem)required

The whole processes of order.

Response
{
  "orderId": {
    "identifier": "string"
  },
  "basketId": {
    "identifier": "string"
  },
  "individualId": "string",
  "participantId": "string",
  "currentStatus": {
    "status": "CREATED / UPDATED / COMPLETED / CANCELLED / FAILED / XBIDRECEIVED / XBIDACCEPTED",
    "reason": "string",
    "createdTime": 1576663249398
  },
  "history": [
    { … }
  ]
}