Headers

• request-id string

  Unique identifier for the API request. Example: f7ecf495-ca1c-4468-a6c2-6ee3f723fa00

Path parameters

• printJobId string Required

  The identifier of the Print Job

Responses

• 200 application/json

  200 response

  Hide response attributes Show response attributes object

  • origin string Required

    The origin of the Print Job (e.g. Remote or Local Barcode)

    Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/" ]*$`.

  • replaceExistingLabel boolean

    Indicate whether to replace the existing Label, in the case where the Asset is already linked to a Label

  • includeCutLine boolean

    Indicates whether the Print Job has a cut line (where to cut a label to de-activate) included

  • templateId string

    The indentifier of the Print Template

    Maximum length is 36.

  • createdAt string(date-time) Required

    Date that the item was created, in UTC. Example: '2019-07-21T17:32:28Z'

    Maximum length is 20. Format should match the following pattern: ^[0-9TZ:-]*$.

  • isSuccessful boolean

    Indicates whether the Print Job was successful

  • assetId string Required

    Unique identifier of the Asset. Example: '00Es43YBJfNRXNSvLmni'

    Maximum length is 20. Format should match the following pattern: ^[-_A-Za-z0-9]*$.

  • failureReason string

    Describes the failure if the Print Job was unsuccessful

    Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/" ]*$`.

  • printerId string Required

    Printer identifier - the serial number of the Printer. Example: 'abcdefgh123456789'

    Maximum length is 50. Format should match the following pattern: ^[-_A-Za-z0-9]*$.

  • id string(uuid) Required

    Unique identifier of the Print Job. Example: 'd290f1ee-6c54-4b01-90e6-d701748f0851'

    Maximum length is 36. Format should match the following pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$.

  • workspaceId string(uuid) Required

    Unique identifier of the workspace. Example: 'd290f1ee-6c54-4b01-90e6-d701748f0851'

    Maximum length is 36. Format should match the following pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$.

  • updatedAt string(date-time)

    Date that the item was last updated, in UTC. Example: '2019-07-21T17:32:28Z'

    Maximum length is 20. Format should match the following pattern: ^[0-9TZ:-]*$.

  • status string Required

    The status of the Print Job

    Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/" ]*$`.

  • isComplete boolean

    Indicates whether the Print Job is complete

• 401 application/json

  Unauthorized

  Hide response attribute Show response attribute object

  • errors array[object] Required
    Hide errors attributes Show errors attributes object

    • code string

      An application-specific error code, expressed as a string value

      Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/"]*$`.

    • id string

      A unique identifier for this particular occurrence of the problem

      Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/"]*$`.

    • detail string

      A human-readable explanation specific to this occurrence of the problem

      Maximum length is 500. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/" ]*$`.

    • title string

      A short, human-readable summary of the problem

      Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/" ]*$`.

    • status string

      The HTTP status code applicable to this problem, expressed as a string value

      Maximum length is 3. Format should match the following pattern: ^[0-9]*$.

• 403 application/json

  Forbidden

  Hide response attribute Show response attribute object

  • errors array[object] Required
    Hide errors attributes Show errors attributes object

    • code string

      An application-specific error code, expressed as a string value

      Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/"]*$`.

    • id string

      A unique identifier for this particular occurrence of the problem

      Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/"]*$`.

    • detail string

      A human-readable explanation specific to this occurrence of the problem

      Maximum length is 500. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/" ]*$`.

    • title string

      A short, human-readable summary of the problem

      Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/" ]*$`.

    • status string

      The HTTP status code applicable to this problem, expressed as a string value

      Maximum length is 3. Format should match the following pattern: ^[0-9]*$.

• 404 application/json

  Printer or Print Job not found

  Hide response attribute Show response attribute object

  • errors array[object] Required
    Hide errors attributes Show errors attributes object

    • code string

      An application-specific error code, expressed as a string value

      Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/"]*$`.

    • id string

      A unique identifier for this particular occurrence of the problem

      Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/"]*$`.

    • detail string

      A human-readable explanation specific to this occurrence of the problem

      Maximum length is 500. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/" ]*$`.

    • title string

      A short, human-readable summary of the problem

      Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/" ]*$`.

    • status string

      The HTTP status code applicable to this problem, expressed as a string value

      Maximum length is 3. Format should match the following pattern: ^[0-9]*$.

• 429 application/json

  Too Many Requests

  Hide response attribute Show response attribute object

  • errors array[object] Required
    Hide errors attributes Show errors attributes object

    • code string

      An application-specific error code, expressed as a string value

      Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/"]*$`.

    • id string

      A unique identifier for this particular occurrence of the problem

      Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/"]*$`.

    • detail string

      A human-readable explanation specific to this occurrence of the problem

      Maximum length is 500. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/" ]*$`.

    • title string

      A short, human-readable summary of the problem

      Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/" ]*$`.

    • status string

      The HTTP status code applicable to this problem, expressed as a string value

      Maximum length is 3. Format should match the following pattern: ^[0-9]*$.