inbound_shipment_location_summary

Fetch inbound shipment location 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.
`owned_by_user`	`Boolean`	No	When true, filters results where owned by user 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

InboundShipmentLocationSummaryQueryResult

Query

query inbound_shipment_location_summary(
  $inbound_shipment_id: String!,
  $owned_by_user: Boolean,
  $analyze: Boolean
) {
  inbound_shipment_location_summary(
    inbound_shipment_id: $inbound_shipment_id,
    owned_by_user: $owned_by_user,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...InboundShipmentLocationSummaryDataFragment
    
      locations {
        ...InboundShipmentLocationSummaryLocationFragment
      
        location {
          ...InboundShipmentSummaryBinFragment
        
          id
          location
          zone
        }
        items_at_location {
          ...InboundShipmentLocationSummaryItemFragment
        
          product_info {
            ...InboundShipmentSummaryProductInfoFragment
          
            id
            sku
            name
          }
          lot {
            ...InboundShipmentSummaryLotFragment
          
            id
            name
            sku
          }
          eaches_quantity
          uom
          is_unexpected
          inbound_shipment_line_item {
            ...InboundShipmentSummaryLineItemFragment
          
            id
            quantity
            quantity_received
            quantity_rejected
          }
        }
      }
    }
  }
}

Variables

{
  "inbound_shipment_id": "SW5ib3VuZFNoaXBtZW50OjEyMzQ=",
  "owned_by_user": true,
  "analyze": true
}

Response

{
  "data": {
    "inbound_shipment_location_summary": {
      "request_id": "UmVjb3JkOjEyMzQ=",
      "complexity": 100,
      "data": {id: "TG9jYXRpb246MTIzNA==", name: "A01-01-01"}
    }
  }
}