Bulk Enrollments

get

Authorizations

Path parameters

idintegerRequired

Query parameters

idintegerRequired

Order id

Responses

200

Getting a specific bulk enrollment

application/json

Responseobject

get

HTTPcURLJavaScriptPython

GET /api/v1/order_items/history/bulk_enrollments/{id} HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Accept: */*

200

Getting a specific bulk enrollment

{
  "bulk_purchase": {
    "order": {
      "id": 4,
      "created_at": "2024-12-20T12:12:29.066827Z",
      "updated_at": "2024-12-20T12:12:30.892895Z",
      "full_id": "4",
      "account_id": 46,
      "user_id": 187,
      "canvas_user_id": 1,
      "canvas_root_account_uuid": "54WLEJdzBmd8nsrZdf5jIATelBOYIMHeY6uuIAEmx",
      "source": "bulk_purchase",
      "currency": "USD",
      "purchased_at": "2024-12-20T12:12:30.892045Z",
      "total": 6,
      "email": "[e-mail]",
      "name": "Saul Goodman",
      "items": [
        {
          "id": 61,
          "created_at": "2024-12-20T12:12:29.068419Z",
          "updated_at": "2024-12-20T12:12:29.068433Z",
          "order_id": 4,
          "item_id": 42,
          "amount": 15,
          "canvas_root_account_uuid": "54WLEJdzBmd8nsrZdf5jIATelBOYIMHeY6uuIAEmx",
          "discounted_amount": 6,
          "quantity": 3,
          "unit_price": 5
        }
      ]
    },
    "product": {
      "id": 42,
      "visibility": "listed",
      "enrollment_open": true,
      "title": "Paid program",
      "enrollment_fee": 5,
      "account_id": 46,
      "type": "Program",
      "canvas_root_account_uuid": "54WLEJdzBmd8nsrZdf5jIATelBOYIMHeY6uuIAEmx",
      "waitlist": false,
      "limited": false,
      "started": false,
      "program": true,
      "course": false,
      "ended": false
    },
    "bulk_invitations": [
      {
        "order_item_id": 61,
        "invitation_id": 4,
        "status": "created"
      },
      {
        "order_item_id": 61,
        "invitation_id": 5,
        "status": "created"
      },
      {
        "order_item_id": 61,
        "invitation_id": 6,
        "status": "created"
      }
    ]
  }
}

get

Authorizations

Query parameters

fromstringOptional

Only include bulk enrollments from this date

tostringOptional

Only include bulk enrollments to this date

canvas_user_idsstringOptional

Only include bulk enrollments for the specified canvas user ids

Responses

200

Listing bulk enrollments

application/json

Responseobject

get

HTTPcURLJavaScriptPython

GET /api/v1/order_items/history/bulk_enrollments HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Accept: */*

200

Listing bulk enrollments

{
  "bulk_enrollments": [
    {
      "bulk_purchase": {
        "order": {
          "id": 5,
          "created_at": "2024-12-20T12:12:29.066827Z",
          "updated_at": "2024-12-20T12:12:30.892895Z",
          "full_id": "5",
          "account_id": 48,
          "user_id": 187,
          "canvas_user_id": 1,
          "canvas_root_account_uuid": "56WLEJdzBmd8nsrZdf5jIATelBOYIMHeY6uuIAEmx",
          "source": "bulk_purchase",
          "currency": "USD",
          "purchased_at": "2024-12-20T12:12:30.892045Z",
          "total": 6,
          "email": "[e-mail]",
          "name": "Saul Goodman",
          "items": [
            {
              "id": 61,
              "created_at": "2024-12-20T12:12:29.068419Z",
              "updated_at": "2024-12-20T12:12:29.068433Z",
              "order_id": 5,
              "item_id": 42,
              "amount": 15,
              "canvas_root_account_uuid": "56WLEJdzBmd8nsrZdf5jIATelBOYIMHeY6uuIAEmx",
              "discounted_amount": 6,
              "quantity": 3,
              "unit_price": 5
            }
          ]
        },
        "product": {
          "id": 42,
          "visibility": "listed",
          "enrollment_open": true,
          "title": "Paid program",
          "enrollment_fee": 5,
          "account_id": 48,
          "type": "Program",
          "canvas_root_account_uuid": "56WLEJdzBmd8nsrZdf5jIATelBOYIMHeY6uuIAEmx",
          "waitlist": false,
          "limited": false,
          "started": false,
          "program": true,
          "course": false,
          "ended": false
        },
        "bulk_invitations": [
          {
            "order_item_id": 61,
            "invitation_id": 4,
            "status": "created"
          },
          {
            "order_item_id": 61,
            "invitation_id": 5,
            "status": "created"
          },
          {
            "order_item_id": 61,
            "invitation_id": 6,
            "status": "created"
          }
        ]
      }
    }
  ]
}