inbound_shipment_images
Fetch inbound shipment images matching the supplied arguments.
Arguments
| Argument | Type | Required | Default | Description |
|---|---|---|---|---|
inbound_shipment_id | String! | Yes | Filter by inbound shipment ID; pass the public API ID unless the field name says legacy ID. Required. | |
analyze | Boolean | No | If true, the query will only be analyzed (cost estimated) without executing it. |
Return Type
InboundShipmentImagesQueryResult
Query
query inbound_shipment_images(
$inbound_shipment_id: String!,
$analyze: Boolean
) {
inbound_shipment_images(
inbound_shipment_id: $inbound_shipment_id,
analyze: $analyze
) {
request_id
complexity
data {
url
filename
mimetype
file_size_bytes
description
created_at
updated_at
}
}
}Variables
{
"inbound_shipment_id": "SW5ib3VuZFNoaXBtZW50OjEyMzQ=",
"analyze": true
}Response
{
"data": {
"inbound_shipment_images": {
"request_id": "UmVjb3JkOjEyMzQ=",
"complexity": 100,
"data": [[{id: "SW5ib3VuZFNoaXBtZW50SW1hZ2U6MTIzNA=="}]]
}
}
}