query · Module: Catalog · Requires catalog:read
Arguments
| Argument | Type | Description |
|---|---|---|
status | String | Filter by status. |
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
PackagingList!
| Field | Type |
|---|---|
data | [Packaging!]! |
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 Packagings($limit: Int) {
packagings(limit: $limit) {
data {
id
object
code
name
type
status
livemode
created
updated
inner_dimensions {
length
width
height
unit
}
outer_dimensions {
length
width
height
unit
}
tare_weight {
value
unit
}
max_weight {
value
unit
}
flat_rate
version
}
has_more
}
}
{
"limit": 10
}
{
"data": {
"packagings": {
"data": [
{
"id": "pkg_1a2B3c",
"object": "packaging",
"code": "dhl_express_worldwide",
"name": "Example",
"type": "envelope",
"status": "draft",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"inner_dimensions": {
"length": 1.5,
"width": 1.5,
"height": 1.5,
"unit": "mm"
},
"outer_dimensions": {
"length": 1.5,
"width": 1.5,
"height": 1.5,
"unit": "mm"
},
"tare_weight": {
"value": 1.5,
"unit": "g"
},
"max_weight": {
"value": 1.5,
"unit": "g"
},
"flat_rate": true,
"version": 3
}
],
"has_more": true
}
}
}