inbound_shipments

Fetch inbound shipments matching the supplied arguments.

Arguments

Argument	Type	Required	Description
`customer_ids`	[`String`]	No	Filter by one or more 3PL child/customer account IDs.
`statuses`	[`String`]	No	Filter by statuses; use values returned by the corresponding status field.
`warehouse_ids`	[`String`]	No	Filter by one or more public API warehouse IDs.
`search_term`	`String`	No	Free-text search term used to match the most relevant records.
`dates_from`	ISODateTime	No	Inclusive start of the dates range, in ISO-8601 datetime format.
`dates_to`	ISODateTime	No	Inclusive end of the dates range, in ISO-8601 datetime format.
`estimated_truck_arrival_from`	ISODateTime	No	Inclusive start of the estimated truck arrival range, in ISO-8601 datetime format.
`estimated_truck_arrival_to`	ISODateTime	No	Inclusive end of the estimated truck arrival range, in ISO-8601 datetime format.
`status_updated_at_from`	ISODateTime	No	Inclusive start of the status updated at range, in ISO-8601 datetime format.
`status_updated_at_to`	ISODateTime	No	Inclusive end of the status updated at range, in ISO-8601 datetime format.
`require_fai`	`Boolean`	No	When true, filters results where require FAI 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

InboundShipmentsQueryResult

Query

query inbound_shipments(
  $customer_ids: [String],
  $statuses: [String],
  $warehouse_ids: [String],
  $search_term: String,
  $dates_from: ISODateTime,
  $dates_to: ISODateTime,
  $estimated_truck_arrival_from: ISODateTime,
  $estimated_truck_arrival_to: ISODateTime,
  $status_updated_at_from: ISODateTime,
  $status_updated_at_to: ISODateTime,
  $require_fai: Boolean,
  $analyze: Boolean
) {
  inbound_shipments(
    customer_ids: $customer_ids,
    statuses: $statuses,
    warehouse_ids: $warehouse_ids,
    search_term: $search_term,
    dates_from: $dates_from,
    dates_to: $dates_to,
    estimated_truck_arrival_from: $estimated_truck_arrival_from,
    estimated_truck_arrival_to: $estimated_truck_arrival_to,
    status_updated_at_from: $status_updated_at_from,
    status_updated_at_to: $status_updated_at_to,
    require_fai: $require_fai,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...InboundShipmentConnectionFragment
    
      pageInfo {
        ...PageInfoFragment
      
        hasNextPage
        hasPreviousPage
        startCursor
        endCursor
      }
      edges {
        ...InboundShipmentEdgeFragment
      
        node {
          ...InboundShipmentFragment
        
          id
          legacy_id
          account_id
          warehouse_id
          status
          carrier
          pro_number
          bol_reference
          bol_url
          expected_dock
          dock_used
          container_number
          notes
          estimated_truck_arrival
          truck_arrived_at
          truck_unload_started_at
          truck_unload_finished_at
          truck_departure_at
          booking_contact_email
          booking_contact_name
          booking_contact_number
          container_size
          load_type
          shipment_type
          number_carton
          pallets_quantity
          people_for_unload
          people_for_receiving
          vendor_id
          created_at
          scheduled_at
          status_updated_at
          warehouse {
            ...WarehouseFragment
          
            id
            legacy_id
            account_id
            identifier
            dynamic_slotting
            invoice_email
            phone_number
            profile
            address {
              ...AddressFragment
            
              name
              address1
              address2
              city
              state
              country
              zip
              phone
            }
            return_address {
              ...AddressFragment
            
              name
              address1
              address2
              city
              state
              country
              zip
              phone
            }
            company_name
            company_alias
            active
            products {
              ...ProductConnectionFragment
            
              pageInfo {
                ...PageInfoFragment
              
                hasNextPage
                hasPreviousPage
                startCursor
                endCursor
              }
              edges {
                ...ProductEdgeFragment
              
                node {
                  ...ProductFragment
                
                  id
                  legacy_id
                  account_id
                  name
                  sku
                  price
                  value
                  value_currency
                  barcode
                  country_of_manufacture
                  dimensions {
                    ...DimensionsFragment
                  
                    weight
                    height
                    width
                    length
                  }
                  tariff_code
                  kit
                  kit_build
                  no_air
                  final_sale
                  customs_value
                  customs_description
                  not_owned
                  dropship
                  needs_serial_number
                  thumbnail
                  large_thumbnail
                  created_at
                  updated_at
                  product_note
                  virtual
                  ignore_on_invoice
                  ignore_on_customs
                  active
                  needs_lot_tracking
                  is_assembly
                  packer_note
                  size
                  style
                  vendor_part_number
                  consumer_package_code
                  buyer_part_number
                  buyer_style_number
                  auto_pack
                  warehouse_products {
                    ...WarehouseProductFragment
                  
                    id
                    legacy_id
                    account_id
                    sku
                    warehouse_id
                    warehouse_identifier
                    price
                    value
                    value_currency
                    on_hand
                    inventory_bin
                    inventory_overstock_bin
                    reserve_inventory
                    replenishment_level
                    replenishment_max_level
                    replenishment_increment
                    reorder_amount
                    reorder_level
                    backorder
                    allocated
                    available
                    non_sellable_quantity
                    in_tote
                    custom
                    customs_value
                    created_at
                    updated_at
                    sell_ahead
                    active
                    warehouse {
                      ...WarehouseFragment
                    }
                    product {
                      ...ProductFragment
                    }
                    inbounds {
                      ...WarehouseProductInboundConnectionFragment
                    }
                    locations {
                      ...ItemLocationConnectionFragment
                    }
                  }
                  fba_inventory {
                    ...FbaInventoryFragment
                  
                    id
                    legacy_id
                    quantity
                    marketplace_id
                    merchant_id
                  }
                  images {
                    ...ProductImageFragment
                  
                    src
                    position
                  }
                  tags
                  vendors {
                    ...ProductVendorFragment
                  
                    vendor_id
                    vendor_sku
                    price
                  }
                  components {
                    ...ProductFragment
                  }
                  kit_components {
                    ...KitComponentFragment
                  
                    id
                    legacy_id
                    account_id
                    sku
                    quantity
                  }
                  assembly_components {
                    ...AssemblyComponentFragment
                  
                    id
                    legacy_id
                    account_id
                    sku
                    quantity
                  }
                  cases {
                    ...CaseFragment
                  
                    id
                    legacy_id
                    case_barcode
                    case_quantity
                  }
                }
                cursor
              }
            }
          }
          purchase_orders {
            ...PurchaseOrderConnectionFragment
          
            pageInfo {
              ...PageInfoFragment
            
              hasNextPage
              hasPreviousPage
              startCursor
              endCursor
            }
            edges {
              ...PurchaseOrderEdgeFragment
            
              node {
                ...PurchaseOrderFragment
              
                id
                legacy_id
                po_number
                account_id
                warehouse_id
                vendor_id
                created_at
                po_date
                date_closed
                arrived_at
                packing_note
                fulfillment_status
                po_note
                description
                partner_order_number
                subtotal
                discount
                total_price
                tax
                shipping_method
                shipping_carrier
                shipping_name
                shipping_price
                tracking_number
                pdf
                images
                payment_method
                payment_due_by
                payment_note
                locking
                locked_by_user_id
                line_items {
                  ...PurchaseOrderLineItemConnectionFragment
                
                  pageInfo {
                    ...PageInfoFragment
                  
                    hasNextPage
                    hasPreviousPage
                    startCursor
                    endCursor
                  }
                  edges {
                    ...PurchaseOrderLineItemEdgeFragment
                  
                    node {
                      ...PurchaseOrderLineItemFragment
                    }
                    cursor
                  }
                }
                attachments {
                  ...PurchaseOrderAttachmentConnectionFragment
                
                  pageInfo {
                    ...PageInfoFragment
                  
                    hasNextPage
                    hasPreviousPage
                    startCursor
                    endCursor
                  }
                  edges {
                    ...PurchaseOrderAttachmentEdgeFragment
                  
                    node {
                      ...PurchaseOrderAttachmentFragment
                    }
                    cursor
                  }
                }
                vendor {
                  ...VendorFragment
                
                  id
                  legacy_id
                  name
                  email
                  account_number
                  account_id
                  address {
                    ...AddressFragment
                  
                    name
                    address1
                    address2
                    city
                    state
                    country
                    zip
                    phone
                  }
                  currency
                  internal_note
                  default_po_note
                  logo
                  partner_vendor_id
                  created_at
                }
                warehouse {
                  ...WarehouseFragment
                
                  id
                  legacy_id
                  account_id
                  identifier
                  dynamic_slotting
                  invoice_email
                  phone_number
                  profile
                  address {
                    ...AddressFragment
                  
                    name
                    address1
                    address2
                    city
                    state
                    country
                    zip
                    phone
                  }
                  return_address {
                    ...AddressFragment
                  
                    name
                    address1
                    address2
                    city
                    state
                    country
                    zip
                    phone
                  }
                  company_name
                  company_alias
                  active
                  products {
                    ...ProductConnectionFragment
                  
                    pageInfo {
                      ...PageInfoFragment
                    }
                    edges {
                      ...ProductEdgeFragment
                    }
                  }
                }
                origin_of_shipment
                tracking_numbers {
                  ...PurchaseOrderTrackingNumberConnectionFragment
                
                  pageInfo {
                    ...PageInfoFragment
                  
                    hasNextPage
                    hasPreviousPage
                    startCursor
                    endCursor
                  }
                  edges {
                    ...PurchaseOrderTrackingNumberEdgeFragment
                  
                    node {
                      ...PurchaseOrderTrackingNumberFragment
                    }
                    cursor
                  }
                }
                ship_date
              }
              cursor
            }
          }
        }
        cursor
      }
      total_count
    }
  }
}

Variables

{
  "customer_ids": ["QWNjb3VudDoxMjM0", "QWNjb3VudDo1Njc4"],
  "statuses": ["pending", "shipped"],
  "warehouse_ids": ["V2FyZWhvdXNlOjEyMzQ=", "V2FyZWhvdXNlOjU2Nzg="],
  "search_term": "BLUE-TEE",
  "dates_from": "2026-07-09T15:30:00Z",
  "dates_to": "2026-07-09T15:30:00Z",
  "estimated_truck_arrival_from": "2026-07-09T15:30:00Z",
  "estimated_truck_arrival_to": "2026-07-09T15:30:00Z",
  "status_updated_at_from": "2026-07-09T15:30:00Z",
  "status_updated_at_to": "2026-07-09T15:30:00Z",
  "require_fai": true,
  "analyze": true
}

Response

{
  "data": {
    "inbound_shipments": {
      "request_id": "UmVjb3JkOjEyMzQ=",
      "complexity": 100,
      "data": [{id: "SW5ib3VuZFNoaXBtZW50Q29ubmVjdGlvbjoxMjM0"}]
    }
  }
}