locations

Fetch locations matching the supplied arguments.

Arguments

Argument	Type	Required	Description
`ids`	[`String`]	No	List of ids of locations to include in the query.
`warehouse_id`	`String`	No	Filter by public API warehouse ID. Use this ID field when selecting a warehouse; warehouse fields are display values or nested objects.
`sku`	`String`	No	Filter by SKU. SKU matching is case-insensitive and ignores surrounding whitespace.
`name`	`String`	No	Filter by location name. Matching is case-insensitive. Unlike the singular location query, this query applies no zone or warehouse scoping.
`pickable`	`Boolean`	No	When true, filters results where pickable applies; when false, filters where it does not.
`sellable`	`Boolean`	No	When true, filters results where sellable applies; when false, filters where it does not.
`location_type_id`	`String`	No	Filter by location type ID; pass the public API ID unless the field name says legacy ID.
`analyze`	`Boolean`	No	If true, the query will only be analyzed (cost estimated) without executing it.

Return Type

LocationsQueryResult

Query

query locations(
  $ids: [String],
  $warehouse_id: String,
  $sku: String,
  $name: String,
  $pickable: Boolean,
  $sellable: Boolean,
  $location_type_id: String,
  $analyze: Boolean
) {
  locations(
    ids: $ids,
    warehouse_id: $warehouse_id,
    sku: $sku,
    name: $name,
    pickable: $pickable,
    sellable: $sellable,
    location_type_id: $location_type_id,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...LocationConnectionFragment
    
      pageInfo {
        ...PageInfoFragment
      
        hasNextPage
        hasPreviousPage
        startCursor
        endCursor
      }
      edges {
        ...LocationEdgeFragment
      
        node {
          ...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
                    }
                    return_address {
                      ...AddressFragment
                    }
                    invoice_address {
                      ...AddressFragment
                    }
                    label_address {
                      ...AddressFragment
                    }
                    company_name
                    company_alias
                    active
                    products {
                      ...ProductConnectionFragment
                    }
                  }
                  product {
                    ...ProductFragment
                  }
                  inbounds {
                    ...WarehouseProductInboundConnectionFragment
                  
                    pageInfo {
                      ...PageInfoFragment
                    }
                    edges {
                      ...WarehouseProductInboundEdgeFragment
                    }
                  }
                  locations {
                    ...ItemLocationConnectionFragment
                  
                    pageInfo {
                      ...PageInfoFragment
                    }
                    edges {
                      ...ItemLocationEdgeFragment
                    }
                  }
                }
                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
                }
                purchase_orders {
                  ...PurchaseOrderConnectionFragment
                
                  pageInfo {
                    ...PageInfoFragment
                  
                    hasNextPage
                    hasPreviousPage
                    startCursor
                    endCursor
                  }
                  edges {
                    ...PurchaseOrderEdgeFragment
                  
                    node {
                      ...PurchaseOrderFragment
                    }
                    cursor
                  }
                }
              }
              cursor
            }
          }
        }
        cursor
      }
    }
  }
}

Variables

{
  "ids": ["TG9jYXRpb246MTIzNA==", "TG9jYXRpb246NTY3OA=="],
  "warehouse_id": "V2FyZWhvdXNlOjEyMzQ=",
  "sku": "BLUE-TEE-M",
  "name": "A01-01-01",
  "pickable": true,
  "sellable": true,
  "location_type_id": "TG9jYXRpb25UeXBlOjEyMzQ=",
  "analyze": true
}

Response

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