List orders
curl --request GET \
--url https://app.spotdx.com/api/v2/orders/ \
--header 'Authorization: <authorization>'
[
{
"order_id": "O1234567",
"status": "pending",
"recipient": {
"first_name": "Alice",
"last_name": "Smith",
"email": "alice123@gmail.com",
"phone": "1234567890",
"address": {
"street1": "123 Main St",
"street2": "Apt 1",
"city": "San Francisco",
"state": "CA",
"country": "US",
"zip": "94105"
}
},
"created": "2023-01-01T04:30:11.222Z",
"updated": "2023-01-01T04:30:11.222Z"
}
]
Authorizations
Token-based authentication with required prefix "Token"
Query Parameters
Only retrieve orders associated with this email address.
Only retrieve orders associated with this first name.
Only retrieve orders associated with this last name.
Only retrieve orders associated with this phone number.
Only retrieve orders that have this status.
canceled
, completed
, in_progress
, pending
Only retrieve orders created on or before this date. Format: YYYY-MM-DD
Only retrieve orders created on or after this date. Format: YYYY-MM-DD
Only retrieve orders updated on or before this date. Format: YYYY-MM-DD
Only retrieve orders updated on or after this date. Format: YYYY-MM-DD
Number of results to return. Must be in range 1-100. Default is 10.
The initial index from which to return the results.
Response
The date and time the order was created.
The order's unique ID.
pending
, in_progress
, completed
, canceled
The date and time the order was last updated.
curl --request GET \
--url https://app.spotdx.com/api/v2/orders/ \
--header 'Authorization: <authorization>'
[
{
"order_id": "O1234567",
"status": "pending",
"recipient": {
"first_name": "Alice",
"last_name": "Smith",
"email": "alice123@gmail.com",
"phone": "1234567890",
"address": {
"street1": "123 Main St",
"street2": "Apt 1",
"city": "San Francisco",
"state": "CA",
"country": "US",
"zip": "94105"
}
},
"created": "2023-01-01T04:30:11.222Z",
"updated": "2023-01-01T04:30:11.222Z"
}
]