Qodex.ai

List and filter placed orders

GET {{baseUrl}}/v1/ordering/order?pageNumber=0&pageSize=20

Request Params

KeyDatatypeRequiredDescription
referencestringThe order reference.
statusstringThe status of the order.
dateFromstringThe date from which you want to filter your listed orders based on the timestamp for the order's creation date (dateAdded) in the format YYYY-MM-DD HH:MM:SS
dateTostringThe date until which you want to filter your listed orders based on the timestamp for the cart's creation date (dateAdded) in the format YYYY-MM-DD HH:MM:SS.
pageNumbernumberThe page number, starting at 0.
pageSizenumberThe page size (max number of entities that are displayed in the response).

HEADERS

KeyDatatypeRequiredDescription
apikeystringAuthentication to Voxbone APIs is handled via key based authentication. You can manage your API key on our platform under Account Settings. Please use our API quickstart guide for more help.
Acceptstring

RESPONSES

status: OK

{"orders":[{"orderId":"\u003cinteger\u003e","reference":"\u003cstring\u003e","dateAdded":"\u003cstring\u003e","dateCanceled":"\u003cstring\u003e","status":"\u003cstring\u003e","customerReference":"\u003cstring\u003e"},{"orderId":"\u003cinteger\u003e","reference":"\u003cstring\u003e","dateAdded":"\u003cstring\u003e","dateCanceled":"\u003cstring\u003e","status":"\u003cstring\u003e","customerReference":"\u003cstring\u003e"}],"resultCount":"\u003cinteger\u003e"}