shipment

Fetch shipment records matching the supplied arguments.

Arguments

ArgumentTypeRequiredDefaultDescription
idStringNo

Filter by ID; pass the public API ID unless the field name says legacy ID.

analyzeBooleanNo

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

Return Type

ShipmentQueryResult

Query

query shipment(
  $id: String,
  $analyze: Boolean
) {
  shipment(
    id: $id,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...ShipmentFragment
    }
  }
}

Variables

{
  "id": "UmVjb3JkOjEyMzQ=",
  "analyze": true
}

Response

{
  "data": {
    "shipment": {
      "request_id": "UmVjb3JkOjEyMzQ=",
      "complexity": 100,
      "data": {id: "U2hpcG1lbnQ6MTIzNA=="}
    }
  }
}