query · Module: Consolidation · Requires consolidation:read
Arguments
| Argument | Type | Description |
|---|---|---|
type | String | Filter by type. |
status | String | Filter by status. |
origin | String | Filter by origin. |
destination | String | Filter by destination. |
conveyance | String | Filter by conveyance. |
identifiersSscc | String | Filter by identifiers.sscc. |
createdGte | Int | Filter by created gte. |
createdLte | Int | Filter by created lte. |
limit | Int | Page size, 1–100 (default 10). |
startingAfter | ID | Cursor: return objects after this ID. |
endingBefore | ID | Cursor: return objects before this ID. |
Returns
ConsolidationList!
| Field | Type |
|---|---|
data | [Consolidation!]! |
has_more | Boolean |
Errors
Errors are returned inerrors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
query Consolidations($limit: Int) {
consolidations(limit: $limit) {
data {
id
object
type
status
livemode
created
updated
owner
identifiers {
sscc
label
uld_id
container_number
postal_receptacle
}
type_code
parent
contents {
consolidations
handling_units
}
counts {
handling_units
shipments
consolidations
}
weight {
value
unit
}
dimensions {
length
width
height
unit
}
origin
}
has_more
}
}
{
"limit": 10
}
{
"data": {
"consolidations": {
"data": [
{
"id": "csl_1a2B3c",
"object": "consolidation",
"type": "bag",
"status": "open",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"owner": "acct_ada",
"identifiers": {
"sscc": "example",
"label": "Example",
"uld_id": "example",
"container_number": "example",
"postal_receptacle": "example"
},
"type_code": "GB",
"parent": "example",
"contents": {
"consolidations": [
"example"
],
"handling_units": [
"example"
]
},
"counts": {
"handling_units": 2,
"shipments": 2,
"consolidations": 2
},
"weight": {
"value": 1.5,
"unit": "g"
},
"dimensions": {
"length": 1.5,
"width": 1.5,
"height": 1.5,
"unit": "mm"
},
"origin": "example"
}
],
"has_more": true
}
}
}