shipments

Arguments

ArgumentTypeRequiredDefaultDescription
customer_account_idStringNo

If you are a 3PL you can specify one of your customer's account

order_idStringNo
date_fromISODateTimeNo
date_toISODateTimeNo
order_date_fromISODateTimeNo
order_date_toISODateTimeNo
tracking_numberStringNo
alternate_tracking_idStringNo
voidedBooleanNo
analyzeBooleanNo

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

Return Type

ShipmentsQueryResult

Query

query shipments(
  $customer_account_id: String,
  $order_id: String,
  $date_from: ISODateTime,
  $date_to: ISODateTime,
  $order_date_from: ISODateTime,
  $order_date_to: ISODateTime,
  $tracking_number: String,
  $alternate_tracking_id: String,
  $voided: Boolean,
  $analyze: Boolean
) {
  shipments(
    customer_account_id: $customer_account_id,
    order_id: $order_id,
    date_from: $date_from,
    date_to: $date_to,
    order_date_from: $order_date_from,
    order_date_to: $order_date_to,
    tracking_number: $tracking_number,
    alternate_tracking_id: $alternate_tracking_id,
    voided: $voided,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...ShipmentConnectionFragment
    }
  }
}

Variables

{
  "customer_account_id": "abc123",
  "order_id": "abc123",
  "date_from": ISODateTime,
  "date_to": ISODateTime,
  "order_date_from": ISODateTime,
  "order_date_to": ISODateTime,
  "tracking_number": "abc123",
  "alternate_tracking_id": "abc123",
  "voided": true,
  "analyze": true
}

Response

{
  "data": {
    "shipments": {
      "request_id": "abc123",
      "complexity": 987,
      "data": ShipmentConnection
    }
  }
}