query · Module: Inbound · Requires inbound:read
Arguments
| Argument | Type | Description |
|---|---|---|
type | String | Filter by type. |
status | String | Filter by status. |
connection | String | Filter by connection. |
tracker | String | Filter by tracker. |
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
InboundEventList!
| Field | Type |
|---|---|
data | [InboundEvent!]! |
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 InboundEvents($limit: Int) {
inboundEvents(limit: $limit) {
data {
id
object
type
status
livemode
created
updated
source
connection
tracker
shipment
accepted
rejected
errors {
code
index
message
}
}
has_more
}
}
{
"limit": 10
}
{
"data": {
"inboundEvents": {
"data": [
{
"id": "ibe_1a2B3c",
"object": "inbound_event",
"type": "tracking",
"status": "processed",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"source": "api",
"connection": "conn_9f8e",
"tracker": "example",
"shipment": "shp_1Q2w3E4r5T6y",
"accepted": 2,
"rejected": 2,
"errors": [
{
"code": "dhl_express_worldwide",
"index": 2,
"message": "example"
}
]
}
],
"has_more": true
}
}
}