inbound_shipment

Fetch inbound shipment records matching the supplied arguments.

Arguments

Argument	Type	Required	Default	Description
`id`	`String`!	Yes		Filter by ID; pass the public API ID unless the field name says legacy ID. Required.
`analyze`	`Boolean`	No		If true, the query will only be analyzed (cost estimated) without executing it.

Return Type

InboundShipmentQueryResult

Query

query inbound_shipment(
  $id: String!,
  $analyze: Boolean
) {
  inbound_shipment(
    id: $id,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...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
                
                  pageInfo {
                    ...PageInfoFragment
                  
                    hasNextPage
                    hasPreviousPage
                    startCursor
                    endCursor
                  }
                  edges {
                    ...WarehouseProductInboundEdgeFragment
                  
                    node {
                      ...WarehouseProductInboundFragment
                    }
                    cursor
                  }
                }
                locations {
                  ...ItemLocationConnectionFragment
                
                  pageInfo {
                    ...PageInfoFragment
                  
                    hasNextPage
                    hasPreviousPage
                    startCursor
                    endCursor
                  }
                  edges {
                    ...ItemLocationEdgeFragment
                  
                    node {
                      ...ItemLocationFragment
                    }
                    cursor
                  }
                }
              }
              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
                
                  id
                  legacy_id
                  po_id
                  account_id
                  warehouse_id
                  vendor_id
                  po_number
                  sku
                  vendor_sku
                  product_id
                  variant_id
                  quantity
                  quantity_received
                  quantity_rejected
                  price
                  product_name
                  option_title
                  expected_weight_in_lbs
                  fulfillment_status
                  sell_ahead
                  note
                  partner_line_item_id
                  barcode
                  updated_at
                  created_at
                  vendor {
                    ...VendorFragment
                  
                    id
                    legacy_id
                    name
                    email
                    account_number
                    account_id
                    address {
                      ...AddressFragment
                    }
                    currency
                    internal_note
                    default_po_note
                    logo
                    partner_vendor_id
                    created_at
                  }
                  product {
                    ...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
                    }
                  }
                  expiration_lots {
                    ...LotConnectionFragment
                  
                    pageInfo {
                      ...PageInfoFragment
                    }
                    edges {
                      ...LotEdgeFragment
                    }
                  }
                }
                cursor
              }
            }
            attachments {
              ...PurchaseOrderAttachmentConnectionFragment
            
              pageInfo {
                ...PageInfoFragment
              
                hasNextPage
                hasPreviousPage
                startCursor
                endCursor
              }
              edges {
                ...PurchaseOrderAttachmentEdgeFragment
              
                node {
                  ...PurchaseOrderAttachmentFragment
                
                  id
                  legacy_id
                  url
                  user_id
                  account_id
                  po_li_sku
                  description
                  filename
                  file_type
                  file_size
                  created_at
                }
                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
                
                  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
                    }
                    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
                    }
                    fba_inventory {
                      ...FbaInventoryFragment
                    }
                    images {
                      ...ProductImageFragment
                    }
                    tags
                    vendors {
                      ...ProductVendorFragment
                    }
                    components {
                      ...ProductFragment
                    }
                    kit_components {
                      ...KitComponentFragment
                    }
                    assembly_components {
                      ...AssemblyComponentFragment
                    }
                    cases {
                      ...CaseFragment
                    }
                  }
                  cursor
                }
              }
            }
            origin_of_shipment
            tracking_numbers {
              ...PurchaseOrderTrackingNumberConnectionFragment
            
              pageInfo {
                ...PageInfoFragment
              
                hasNextPage
                hasPreviousPage
                startCursor
                endCursor
              }
              edges {
                ...PurchaseOrderTrackingNumberEdgeFragment
              
                node {
                  ...PurchaseOrderTrackingNumberFragment
                
                  id
                  legacy_id
                  po_id
                  carrier_id
                  carrier_value
                  tracking_number
                }
                cursor
              }
            }
            ship_date
          }
          cursor
        }
      }
    }
  }
}

Variables

{
  "id": "UmVjb3JkOjEyMzQ=",
  "analyze": true
}

Response

{
  "data": {
    "inbound_shipment": {
      "request_id": "UmVjb3JkOjEyMzQ=",
      "complexity": 100,
      "data": {id: "SW5ib3VuZFNoaXBtZW50OjEyMzQ="}
    }
  }
}