inbound_shipment_summary

Fetch inbound shipment summary records matching the supplied arguments.

Arguments

Argument	Type	Required	Description
`inbound_shipment_id`	`String`!	Yes	Filter by inbound shipment ID; pass the public API ID unless the field name says legacy ID. Required.
`only_owned_by_user`	`Boolean`	No	When true, filters results where only owned by user applies; when false, filters where it does not.
`only_boxes_non_palletized`	`Boolean`	No	When true, filters results where only boxes non palletized applies; when false, filters where it does not.
`filter_by_location_id`	`String`	No	Filter by filter by location ID; pass the public API ID unless the field name says legacy ID.
`lpn_id`	`String`	No	Filter by LPN ID; pass the public API ID unless the field name says legacy ID.
`sort_by`	[`String`]	No	Filter by one or more sort by values.
`include_rejected`	`Boolean`	No	When true, filters results where include rejected applies; when false, filters where it does not.
`analyze`	`Boolean`	No	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
    
      stats {
        ...InboundShipmentSummaryStatsFragment
      
        unpalletized_boxes_count
        pallets_count
      }
      in_lpns {
        ...InboundShipmentSummaryInLPNFragment
      
        lpn {
          ...InboundShipmentSummaryLPNFragment
        
          id
          barcode
          container_type
        }
        content {
          ...InboundShipmentSummaryContentFragment
        
          product_info {
            ...InboundShipmentSummaryProductInfoFragment
          
            id
            sku
            name
          }
          lot {
            ...InboundShipmentSummaryLotFragment
          
            id
            name
            sku
          }
          quantity_received
          quantity_loose
          is_unexpected
          inbound_shipment_line_item {
            ...InboundShipmentSummaryLineItemFragment
          
            id
            quantity
            quantity_received
            quantity_rejected
          }
          containers {
            ...InboundShipmentSummaryLPNContainerFragment
          
            lpn {
              ...InboundShipmentSummaryLPNFragment
            
              id
              barcode
              container_type
            }
            quantity_received
          }
          receiving_location {
            ...InboundShipmentSummaryBinFragment
          
            id
            location
            zone
          }
          receiving_workers {
            ...InboundShipmentSummaryWorkerFragment
          
            id
            first_name
            last_name
          }
        }
        quantity_received
        quantity_loose
        received_location {
          ...InboundShipmentSummaryBinFragment
        
          id
          location
          zone
        }
      }
    }
  }
}

Variables

{
  "inbound_shipment_id": "SW5ib3VuZFNoaXBtZW50OjEyMzQ=",
  "only_owned_by_user": true,
  "only_boxes_non_palletized": true,
  "filter_by_location_id": "TG9jYXRpb246MTIzNA==",
  "lpn_id": "TGljZW5zZVBsYXRlTnVtYmVyOjEyMzQ=",
  "sort_by": ["EXPECTED_DOCK_ASC", "EXPECTED_DOCK_DESC"],
  "include_rejected": true,
  "analyze": true
}

Response

{
  "data": {
    "inbound_shipment_summary": {
      "request_id": "UmVjb3JkOjEyMzQ=",
      "complexity": 100,
      "data": {id: "SW5ib3VuZFNoaXBtZW50U3VtbWFyeURhdGE6MTIzNA=="}
    }
  }
}