item_locations

Fetch item locations matching the supplied arguments.

Arguments

ArgumentTypeRequiredDefaultDescription
warehouse_idStringNo

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.

customer_account_idStringNo

Filter by 3PL child/customer account ID; omit to use the authenticated account.

location_name[String]No

Filter by one or more location name values.

location_name_prefixStringNo

Filter by location name prefix.

has_inventoryBooleanNo

When true, filters results where has inventory 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.

pickableBooleanNo

When true, filters results where pickable applies; when false, filters where it does not.

sellableBooleanNo

When true, filters results where sellable applies; when false, filters where it does not.

created_fromISODateTimeNo

Inclusive start of the created range, in ISO-8601 datetime format.

created_toISODateTimeNo

Inclusive end of the created range, in ISO-8601 datetime format.

updated_fromISODateTimeNo

Inclusive start of the updated range, in ISO-8601 datetime format.

updated_toISODateTimeNo

Inclusive end of the updated range, in ISO-8601 datetime format.

analyzeBooleanNo

If true, the query will only be analyzed (cost estimated) without executing it.

Return Type

ItemLocationsQueryResult

Query

query item_locations(
  $warehouse_id: String,
  $sku: [String],
  $customer_account_id: String,
  $location_name: [String],
  $location_name_prefix: String,
  $has_inventory: Boolean,
  $location_type_id: [String],
  $pickable: Boolean,
  $sellable: Boolean,
  $created_from: ISODateTime,
  $created_to: ISODateTime,
  $updated_from: ISODateTime,
  $updated_to: ISODateTime,
  $analyze: Boolean
) {
  item_locations(
    warehouse_id: $warehouse_id,
    sku: $sku,
    customer_account_id: $customer_account_id,
    location_name: $location_name,
    location_name_prefix: $location_name_prefix,
    has_inventory: $has_inventory,
    location_type_id: $location_type_id,
    pickable: $pickable,
    sellable: $sellable,
    created_from: $created_from,
    created_to: $created_to,
    updated_from: $updated_from,
    updated_to: $updated_to,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...ItemLocationConnectionFragment
    }
  }
}

Variables

{
  "warehouse_id": "V2FyZWhvdXNlOjEyMzQ=",
  "sku": ["BLUE-TEE-M", "RED-HOODIE-L"],
  "customer_account_id": "QWNjb3VudDoxMjM0",
  "location_name": ["A01-01-01", "B02-02-02"],
  "location_name_prefix": "A01-01-01",
  "has_inventory": true,
  "location_type_id": ["TG9jYXRpb25UeXBlOjEyMzQ="],
  "pickable": true,
  "sellable": true,
  "created_from": "2026-07-09T15:30:00Z",
  "created_to": "2026-07-09T15:30:00Z",
  "updated_from": "2026-07-09T15:30:00Z",
  "updated_to": "2026-07-09T15:30:00Z",
  "analyze": true
}

Response

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