inbound_shipment_summary

Arguments

ArgumentTypeRequiredDefaultDescription
inbound_shipment_idString!Yes
only_owned_by_userBooleanNo
only_boxes_non_palletizedBooleanNo
filter_by_location_idStringNo
lpn_idStringNo
sort_by[String]No
include_rejectedBooleanNo
analyzeBooleanNo

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

Return Type

InboundShipmentSummaryQueryResult

Query

query inbound_shipment_summary(
  $inbound_shipment_id: String!,
  $only_owned_by_user: Boolean,
  $only_boxes_non_palletized: Boolean,
  $filter_by_location_id: String,
  $lpn_id: String,
  $sort_by: [String],
  $include_rejected: Boolean,
  $analyze: Boolean
) {
  inbound_shipment_summary(
    inbound_shipment_id: $inbound_shipment_id,
    only_owned_by_user: $only_owned_by_user,
    only_boxes_non_palletized: $only_boxes_non_palletized,
    filter_by_location_id: $filter_by_location_id,
    lpn_id: $lpn_id,
    sort_by: $sort_by,
    include_rejected: $include_rejected,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...InboundShipmentSummaryDataFragment
    }
  }
}

Variables

{
  "inbound_shipment_id": "abc123",
  "only_owned_by_user": true,
  "only_boxes_non_palletized": true,
  "filter_by_location_id": "abc123",
  "lpn_id": "abc123",
  "sort_by": ["abc123"],
  "include_rejected": true,
  "analyze": true
}

Response

{
  "data": {
    "inbound_shipment_summary": {
      "request_id": "abc123",
      "complexity": 987,
      "data": InboundShipmentSummaryData
    }
  }
}