Orders
get
Authorizations
Path parameters
idintegerRequired
Responses
200
Getting a specific order
application/json
get
GET /api/v1/orders/{id} HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Accept: */*
200
Getting a specific order
{
"order": {
"id": 3,
"full_id": "3",
"catalog_id": 45,
"catalog": {
"id": 45,
"name": "Domain Account 54"
},
"user": {
"id": 1,
"name": "Saul Goodman",
"email": "[email protected]"
},
"listings": [
{
"id": 26,
"canvas_course_id": 14,
"title": "Course 24",
"amount": "100.0",
"discounted_amount": "90.0",
"catalog_id": 45
}
],
"promotions": [
{
"id": 5,
"listing_id": 26,
"code": "PROMO5",
"amount": "-10.0"
}
],
"payments": [
{
"reference_id": "123",
"status": "success",
"amount": "90.0"
}
],
"total": "90.0",
"currency": "USD",
"purchased_at": "2025/06/10 13:42:06 +0000",
"created_at": "2025/06/10 13:42:06 +0000"
}
}
get
Authorizations
Query parameters
fromstringOptional
Earliest date/time to return. Suggested format YYYY-MM-DDTHH:MM:SSZ, e.g. 2018-01-01T00:00:00Z. System time zone is UTC.
tostringOptional
Latest date/time to return. See 'from' above for format.
canvas_user_idstringOptional
Return only orders for the specified Canvas user ID
completedstringOptional
When set, only return orders that were completed successfully
Responses
200
Listing orders
application/json
Responseobject
get
GET /api/v1/orders HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Accept: */*
200
Listing orders
{
"orders": [
{
"id": 4,
"full_id": "4",
"catalog_id": 46,
"catalog": {
"id": 46,
"name": "Domain Account 55"
},
"user": {
"id": 1,
"name": "Saul Goodman",
"email": "[email protected]"
},
"listings": [
{
"id": 27,
"canvas_course_id": 15,
"title": "Course 25",
"amount": "100.0",
"discounted_amount": "90.0",
"catalog_id": 46
}
],
"promotions": [
{
"id": 6,
"listing_id": 27,
"code": "PROMO6",
"amount": "-10.0"
}
],
"payments": [
{
"reference_id": "123",
"status": "success",
"amount": "90.0"
}
],
"total": "90.0",
"currency": "USD",
"purchased_at": "2025/06/10 13:42:07 +0000",
"created_at": "2025/06/10 13:42:07 +0000"
}
]
}
Last updated
Was this helpful?