query · Module: Templates · Requires templates:read
Arguments
Returns
DocumentJob!
Errors
Errors are returned inerrors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
query DocumentJob($id: ID!) {
documentJob(id: $id) {
id
object
type
status
livemode
created
updated
template
counts {
total
succeeded
failed
}
output
result_file
errors {
object
code
message
}
}
}
{
"id": "djob_1a2B3c"
}
{
"data": {
"documentJob": {
"id": "djob_1a2B3c",
"object": "document_job",
"type": "example",
"status": "processing",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"template": "dtpl_packslip_v2",
"counts": {
"total": 1299,
"succeeded": 2,
"failed": 2
},
"output": "merged",
"result_file": "example",
"errors": [
{
"object": "document_job_errors_item",
"code": "dhl_express_worldwide",
"message": "example"
}
]
}
}
}
Retrieve a DocumentJob
query DocumentJob($id: ID!) {
documentJob(id: $id) {
id
object
type
status
livemode
created
updated
template
counts {
total
succeeded
failed
}
output
result_file
errors {
object
code
message
}
}
}
{
"id": "djob_1a2B3c"
}
{
"data": {
"documentJob": {
"id": "djob_1a2B3c",
"object": "document_job",
"type": "example",
"status": "processing",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"template": "dtpl_packslip_v2",
"counts": {
"total": 1299,
"succeeded": 2,
"failed": 2
},
"output": "merged",
"result_file": "example",
"errors": [
{
"object": "document_job_errors_item",
"code": "dhl_express_worldwide",
"message": "example"
}
]
}
}
}
query · Module: Templates · Requires templates:read
| Argument | Type | Description |
|---|---|---|
id | ID! | The object’s ID. |
DocumentJob!
| Field | Type |
|---|---|
id | String! |
object | DocumentJobObject! |
livemode | Boolean! |
created | Int! |
updated | Int |
template | String |
type | String |
status | DocumentJobStatus! |
counts | DocumentJobCounts |
output | DocumentJobOutput! |
result_file | String |
errors | [DocumentJobErrorsItem!] |
user_metadata | UserMetadata |
carrier_metadata | CarrierMetadata |
system_metadata | SystemMetadata |
errors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
query DocumentJob($id: ID!) {
documentJob(id: $id) {
id
object
type
status
livemode
created
updated
template
counts {
total
succeeded
failed
}
output
result_file
errors {
object
code
message
}
}
}
{
"id": "djob_1a2B3c"
}
{
"data": {
"documentJob": {
"id": "djob_1a2B3c",
"object": "document_job",
"type": "example",
"status": "processing",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"template": "dtpl_packslip_v2",
"counts": {
"total": 1299,
"succeeded": 2,
"failed": 2
},
"output": "merged",
"result_file": "example",
"errors": [
{
"object": "document_job_errors_item",
"code": "dhl_express_worldwide",
"message": "example"
}
]
}
}
}