query · Module: Batches
Arguments
Returns
Batch!
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 Batche($id: ID!) {
batche(id: $id) {
id
object
status
livemode
created
updated
operation
counts {
total
succeeded
failed
}
results_file
}
}
{
"id": "bat_1a2B3c"
}
{
"data": {
"batche": {
"id": "bat_1a2B3c",
"object": "batch",
"status": "processing",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"operation": "shipments_create",
"counts": {
"total": 1299,
"succeeded": 2,
"failed": 2
},
"results_file": "example"
}
}
}
Retrieve a batch
query Batche($id: ID!) {
batche(id: $id) {
id
object
status
livemode
created
updated
operation
counts {
total
succeeded
failed
}
results_file
}
}
{
"id": "bat_1a2B3c"
}
{
"data": {
"batche": {
"id": "bat_1a2B3c",
"object": "batch",
"status": "processing",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"operation": "shipments_create",
"counts": {
"total": 1299,
"succeeded": 2,
"failed": 2
},
"results_file": "example"
}
}
}
query · Module: Batches
| Argument | Type | Description |
|---|---|---|
id | ID! | The object’s ID. |
Batch!
| Field | Type |
|---|---|
id | String! |
object | BatchObject! |
livemode | Boolean! |
created | Int! |
updated | Int |
operation | BatchOperation! |
status | BatchStatus! |
counts | BatchCounts |
results_file | String |
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 Batche($id: ID!) {
batche(id: $id) {
id
object
status
livemode
created
updated
operation
counts {
total
succeeded
failed
}
results_file
}
}
{
"id": "bat_1a2B3c"
}
{
"data": {
"batche": {
"id": "bat_1a2B3c",
"object": "batch",
"status": "processing",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"operation": "shipments_create",
"counts": {
"total": 1299,
"succeeded": 2,
"failed": 2
},
"results_file": "example"
}
}
}