Retrieve Printed Items

Returns a collection of job records. The contents of the returned collection depends on the query parameters that serve as a filter (e.g., "jobId=2022-08-30/1")

For more information about this command, including descriptions of any path and request parameters, request body schema, response codes and schemas, and payload examples, refer to the online API reference for this command at the following web page: Retrieve printed items

URI

The bartendercloud.com domain that is referenced in the URI and in the code examples that follow must be replaced with the contents of the DataCenterURI claim that is extracted from your access token. For more information, refer to Extracting the DataCenterURI Claim.

Responses

200 Success

Response Schema: application/json

Array

JobId	string or null The job ID of this printed item
PageNumber	integer <int32> The page number within the job (as identified by the JobId)
Position	integer <int32> Normally 1. But if the page is split into rows and columns, then the position number identifies the location of the printed item on the page.
ItemNumber	integer <int32> Normally 1. But if a print job has more than one item in it, this number increments sequentially from 1 to n, all the way to the last item in the print job.
BackSide	boolean Flags this item as having been print on the back side of the label.
TemplateName	string or null The name of the template used to print the item.
TemplateUri	string or null The URI of the template at this position
Object Values	object or null Records the object values for text, barcode, and graphic fields

400 Bad Request

Response Schema: application/json

One of

type	string or null
title	string or null
status	integer or null <int32>
detail	string or null
instance	string or null
property name*   additional property	any

One of

Errors	object or null
type	string or null
title	string or null
status	integer or null <int32>
detail	string or null
instance	string or null
property name*   additional property	any

401 Unauthorized

Response Schema: application/json

One of

type	string or null
title	string or null
status	integer or null <int32>
detail	string or null
instance	string or null
property name*   additional property	any

One of

Errors	object or null
type	string or null
title	string or null
status	integer or null <int32>
detail	string or null
instance	string or null
property name*   additional property	any

404 Not Found

Response Schema: application/json

One of

type	string or null
title	string or null
status	integer or null <int32>
detail	string or null
instance	string or null
property name*   additional property	any

One of

Errors	object or null
type	string or null
title	string or null
status	integer or null <int32>
detail	string or null
instance	string or null
property name*   additional property	any

500 Server Error

 

Path Parameters

None.

Example

You can use any one of several methods to send the command to the server, as shown in the following code samples.

In each of the following samples, you must replace "____PASTE_YOUR_ACCESS_TOKEN_HERE____" with your access token. For more information about your access token, refer to Authentication.

• cURL