Bundles

Create a new Bundle

OAuth Scope

This endpoint requires the following OAuth scope manage_inventory.

Record UUID

UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the x-record-uuid response header.

post/materialbundle.json

Request body

uuidstring uuid

Unique identifier for this record

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 request

{
  "uuid": "123e4567-0d80-4db2-bf22-23f94628766b"
}

Response

Success

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes

Changed in 4 of the 50 revisions of this API.16

    • added the new optional request property material_list/items/sort_order

      new-optional-request-property

    • removed the request property active

      request-property-removed

    • 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 429

      response-non-success-status-added

    • added the non-success response with the status 500

      response-non-success-status-added

    • the security scope manage_inventory was added to the endpoint's security scheme oauth2

      api-security-scope-added