location

Fetch location records matching the supplied arguments.

Arguments

Argument	Type	Required	Description
`id`	`String`	No	Filter by ID; pass the public API ID unless the field name says legacy ID.
`name`	`String`	No	Filter by location name. Matching is case-insensitive. Names are unique per warehouse and zone, so the same name may exist in more than one zone.
`analyze`	`Boolean`	No	If true, the query will only be analyzed (cost estimated) without executing it.

Return Type

LocationQueryResult

Query

query location(
  $id: String,
  $name: String,
  $analyze: Boolean
) {
  location(
    id: $id,
    name: $name,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...LocationFragment
    
      id
      legacy_id
      account_id
      warehouse_id
      type {
        ...LocationTypeFragment
      
        id
        legacy_id
        account_id
        name
        daily_storage_cost
        category
        is_lpn_allowed
      }
      name
      zone
      pickable
      sellable
      staging
      is_cart
      pick_priority
      dimensions {
        ...DimensionsFragment
      
        weight
        height
        width
        length
      }
      length
      width
      height
      max_weight
      temperature
      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
            merchant_product_id
            non_standard_manufacturer_product_id
            standard_manufacturer_product_id
            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
              
                id
                legacy_id
                account_id
                identifier
                dynamic_slotting
                invoice_email
                invoice_note
                invoice_logo_url
                phone_number
                profile
                language
                manual_order_prefix
                show_phone_on_invoice
                only_pick_orders_with_required_ship_date_today_or_earlier
                exclude_stock_from_available_to_sell
                address {
                  ...AddressFragment
                
                  name
                  address1
                  address2
                  city
                  state
                  country
                  zip
                  phone
                }
                return_address {
                  ...AddressFragment
                
                  name
                  address1
                  address2
                  city
                  state
                  country
                  zip
                  phone
                }
                invoice_address {
                  ...AddressFragment
                
                  name
                  address1
                  address2
                  city
                  state
                  country
                  zip
                  phone
                }
                label_address {
                  ...AddressFragment
                
                  name
                  address1
                  address2
                  city
                  state
                  country
                  zip
                  phone
                }
                company_name
                company_alias
                active
                products {
                  ...ProductConnectionFragment
                }
              }
              product {
                ...ProductFragment
              }
              inbounds {
                ...WarehouseProductInboundConnectionFragment
              
                pageInfo {
                  ...PageInfoFragment
                
                  hasNextPage
                  hasPreviousPage
                  startCursor
                  endCursor
                }
                edges {
                  ...WarehouseProductInboundEdgeFragment
                
                  node {
                    ...WarehouseProductInboundFragment
                  
                    id
                    legacy_id
                    sku
                    warehouse_id
                    po_id
                    purchase_order_line_item_id
                    po_date
                    quantity
                    quantity_received
                    quantity_rejected
                    sell_ahead
                    status
                  }
                  cursor
                }
              }
              locations {
                ...ItemLocationConnectionFragment
              
                pageInfo {
                  ...PageInfoFragment
                
                  hasNextPage
                  hasPreviousPage
                  startCursor
                  endCursor
                }
                edges {
                  ...ItemLocationEdgeFragment
                
                  node {
                    ...ItemLocationFragment
                  
                    id
                    legacy_id
                    account_id
                    warehouse_id
                    location_id
                    sku
                    quantity
                    loose_quantity
                    allocated_quantity
                    created_at
                    updated_at
                    location {
                      ...LocationFragment
                    }
                    location_type {
                      ...LocationTypeFragment
                    }
                    expiration_lot {
                      ...LotFragment
                    }
                    lpns {
                      ...LicensePlateNumberConnectionFragment
                    }
                    product {
                      ...ProductFragment
                    }
                    warehouse_product {
                      ...WarehouseProductFragment
                    }
                  }
                  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
              product {
                ...ProductFragment
              }
            }
            assembly_components {
              ...AssemblyComponentFragment
            
              id
              legacy_id
              account_id
              sku
              quantity
            }
            cases {
              ...CaseFragment
            
              id
              legacy_id
              case_barcode
              case_quantity
            }
          }
          cursor
        }
      }
      last_counted
      created_at
      expiration_lots {
        ...LotConnectionFragment
      
        pageInfo {
          ...PageInfoFragment
        
          hasNextPage
          hasPreviousPage
          startCursor
          endCursor
        }
        edges {
          ...LotEdgeFragment
        
          node {
            ...LotFragment
          
            id
            legacy_id
            account_id
            po_id
            name
            sku
            created_at
            updated_at
            expires_at
            received_at
            is_active
            locations {
              ...LocationConnectionFragment
            
              pageInfo {
                ...PageInfoFragment
              
                hasNextPage
                hasPreviousPage
                startCursor
                endCursor
              }
              edges {
                ...LocationEdgeFragment
              
                node {
                  ...LocationFragment
                }
                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
                    }
                    edges {
                      ...PurchaseOrderLineItemEdgeFragment
                    }
                  }
                  attachments {
                    ...PurchaseOrderAttachmentConnectionFragment
                  
                    pageInfo {
                      ...PageInfoFragment
                    }
                    edges {
                      ...PurchaseOrderAttachmentEdgeFragment
                    }
                  }
                  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
                  }
                  warehouse {
                    ...WarehouseFragment
                  
                    id
                    legacy_id
                    account_id
                    identifier
                    dynamic_slotting
                    invoice_email
                    invoice_note
                    invoice_logo_url
                    phone_number
                    profile
                    language
                    manual_order_prefix
                    show_phone_on_invoice
                    only_pick_orders_with_required_ship_date_today_or_earlier
                    exclude_stock_from_available_to_sell
                    address {
                      ...AddressFragment
                    }
                    return_address {
                      ...AddressFragment
                    }
                    invoice_address {
                      ...AddressFragment
                    }
                    label_address {
                      ...AddressFragment
                    }
                    company_name
                    company_alias
                    active
                    products {
                      ...ProductConnectionFragment
                    }
                  }
                  origin_of_shipment
                  tracking_numbers {
                    ...PurchaseOrderTrackingNumberConnectionFragment
                  
                    pageInfo {
                      ...PageInfoFragment
                    }
                    edges {
                      ...PurchaseOrderTrackingNumberEdgeFragment
                    }
                  }
                  ship_date
                }
                cursor
              }
            }
          }
          cursor
        }
      }
    }
  }
}

Variables

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

Response

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