shipping_containers

Fetch shipping containers matching the supplied arguments.

Arguments

ArgumentTypeRequiredDefaultDescription
warehouse_idStringNo

Filter by public API warehouse ID. Use this ID field when selecting a warehouse; warehouse fields are display values or nested objects.

carrierStringNo

Filter by carrier.

shipping_methodStringNo

Filter by shipping method.

created_fromISODateTimeNo

Inclusive start of the created range, in ISO-8601 datetime format.

created_toISODateTimeNo

Inclusive end of the created range, in ISO-8601 datetime format.

updated_fromISODateTimeNo

Inclusive start of the updated range, in ISO-8601 datetime format.

updated_toISODateTimeNo

Inclusive end of the updated range, in ISO-8601 datetime format.

shipped_date_fromISODateTimeNo

Inclusive start of the shipped date range, in ISO-8601 datetime format.

shipped_date_toISODateTimeNo

Inclusive end of the shipped date range, in ISO-8601 datetime format.

analyzeBooleanNo

If true, the query will only be analyzed (cost estimated) without executing it.

Return Type

ShippingContainersQueryResult

Query

query shipping_containers(
  $warehouse_id: String,
  $carrier: String,
  $shipping_method: String,
  $created_from: ISODateTime,
  $created_to: ISODateTime,
  $updated_from: ISODateTime,
  $updated_to: ISODateTime,
  $shipped_date_from: ISODateTime,
  $shipped_date_to: ISODateTime,
  $analyze: Boolean
) {
  shipping_containers(
    warehouse_id: $warehouse_id,
    carrier: $carrier,
    shipping_method: $shipping_method,
    created_from: $created_from,
    created_to: $created_to,
    updated_from: $updated_from,
    updated_to: $updated_to,
    shipped_date_from: $shipped_date_from,
    shipped_date_to: $shipped_date_to,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...ShippingContainerConnectionFragment
    }
  }
}

Variables

{
  "warehouse_id": "V2FyZWhvdXNlOjEyMzQ=",
  "carrier": "ups",
  "shipping_method": "ups_ground",
  "created_from": "2026-07-09T15:30:00Z",
  "created_to": "2026-07-09T15:30:00Z",
  "updated_from": "2026-07-09T15:30:00Z",
  "updated_to": "2026-07-09T15:30:00Z",
  "shipped_date_from": "2026-07-09T15:30:00Z",
  "shipped_date_to": "2026-07-09T15:30:00Z",
  "analyze": true
}

Response

{
  "data": {
    "shipping_containers": {
      "request_id": "UmVjb3JkOjEyMzQ=",
      "complexity": 100,
      "data": [{id: "U2hpcHBpbmdDb250YWluZXJDb25uZWN0aW9uOjEyMzQ="}]
    }
  }
}