Skip to main content

Arguments

batchId : ID

The print batch ID.

printBatchId : Int

The print batch ID.

Deprecation
The 'printBatchId' field is deprecated.


Please use 'batchId' instead.


- Marked as deprecated on 2023-08-30.
- Scheduled for removal on or after 2024-08-30.

Returns

PrintBatchType!

Represents print batch details

Allowed Viewers

Customer Partner User Third party

Required Permissions

Can query print batches

Query Complexity

1

Examples

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Query

query PrintBatch($batchId: ID) { printBatch(batchId: $batchId) { id messages { ...PrintMessageTypeConnectionFragment } status } }

Variables

{ "batchId": "42488877" }

Response

{ "data": { "printBatch": { "id": "22597847", "messages": PrintMessageTypeConnection, "status": "OPEN" } } }