Sign in
Bundles

Retrieve a Bundle

OAuth Scope

This endpoint requires the following OAuth scope read_inventory.

get/materialbundle/{uuid}.json

Path parameters

uuidstring uuid required

UUID of the Bundle

Response

Bundle record retrieved successfully

uuidstring uuid

Unique identifier for this record

active0 | 1

Record active/deleted flag. Valid values are [0,1]

edit_datestring

Timestamp at which record was last modified

item_numberstring required

Unique identifier for this bundle. Must be 30 characters or less and unique across both Materials and Bundles. Used when adding bundles to jobs.

namestring

The display name of the bundle. Used for identification in the system and shows on documents when the bundle is added to a job.

Example response

{
  "uuid": "123e4567-b6d8-4938-9093-23f94402363b",
  "edit_date": "2026-03-01 12:00:00"
}

Changes

Changed in 3 of the 50 revisions of this API.7

  • 3999cf7e5b401See the full diff
    • ○

      added the optional property material_list/items/sort_order to the response with the 200 status

      response-optional-property-added

  • ca9b053c43735See the full diff
    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the non-success response with the status 404

      response-non-success-status-added

    • ○

      added the non-success response with the status 429

      response-non-success-status-added

    • ○

      added the non-success response with the status 500

      response-non-success-status-added

  • e859f8c27a211See the full diff
    • ○

      the security scope read_inventory was added to the endpoint's security scheme oauth2

      api-security-scope-added