Orders

get

Authorizations

Authorization

AuthorizationstringRequired

API Token based authentication. Use format: Token token="your-api-key"

Path parameters

idintegerRequired

Responses

200

Getting a specific order

application/json

get

/api/v1/orders/{id}

HTTPcURLJavaScriptPython

GET /api/v1/orders/{id} HTTP/1.1
Host: REPLACE_ME
Authorization: YOUR_API_KEY
Accept: */*

200

Getting a specific order

{
  "order": {
    "id": 1,
    "full_id": "1",
    "catalog_id": 4,
    "catalog": {
      "id": 4,
      "name": "Domain Account 4"
    },
    "user": {
      "id": 1,
      "name": "Saul Goodman",
      "email": "[email protected]"
    },
    "listings": [
      {
        "id": 4,
        "canvas_course_id": 4,
        "title": "Course 4",
        "amount": "100.0",
        "discounted_amount": "90.0",
        "catalog_id": 4
      }
    ],
    "promotions": [
      {
        "id": 1,
        "listing_id": 4,
        "code": "PROMO1",
        "amount": "-10.0"
      }
    ],
    "payments": [
      {
        "reference_id": "123",
        "status": "success",
        "amount": "90.0"
      }
    ],
    "total": "90.0",
    "currency": "USD",
    "purchased_at": "2024/01/01 00:00:00 +0000",
    "created_at": "2024/01/01 00:00:00 +0000"
  }
}

get

Authorizations

Authorization

AuthorizationstringRequired

API Token based authentication. Use format: Token token="your-api-key"

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

/api/v1/orders

HTTPcURLJavaScriptPython

GET /api/v1/orders HTTP/1.1
Host: REPLACE_ME
Authorization: YOUR_API_KEY
Accept: */*

200

Listing orders

{
  "orders": [
    {
      "id": 2,
      "full_id": "2",
      "catalog_id": 5,
      "catalog": {
        "id": 5,
        "name": "Domain Account 5"
      },
      "user": {
        "id": 1,
        "name": "Saul Goodman",
        "email": "[email protected]"
      },
      "listings": [
        {
          "id": 5,
          "canvas_course_id": 5,
          "title": "Course 5",
          "amount": "100.0",
          "discounted_amount": "90.0",
          "catalog_id": 5
        }
      ],
      "promotions": [
        {
          "id": 2,
          "listing_id": 5,
          "code": "PROMO2",
          "amount": "-10.0"
        }
      ],
      "payments": [
        {
          "reference_id": "123",
          "status": "success",
          "amount": "90.0"
        }
      ],
      "total": "90.0",
      "currency": "USD",
      "purchased_at": "2024/01/01 00:00:00 +0000",
      "created_at": "2024/01/01 00:00:00 +0000"
    }
  ]
}