Bundles

Create a new Bundle

Changed on

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

  • Base URL
    https://api.servicem8.com/api_1.0
  • URL
    https://api.servicem8.com/api_1.0/materialbundle.json
  • Auth
    • API key in header X-Api-Key
    • or OAuth 2
      Authorization code: https://api.servicem8.com/oauth/authorize
      Token URL: https://api.servicem8.com/oauth/access_token scopes: manage_inventory

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