item_locations

Arguments

ArgumentTypeRequiredDefaultDescription
warehouse_idStringNo
sku[String]No
customer_account_idStringNo
location_name[String]No
location_name_prefixStringNo
has_inventoryBooleanNo
location_type_id[String]No
pickableBooleanNo
sellableBooleanNo
created_fromISODateTimeNo
created_toISODateTimeNo
updated_fromISODateTimeNo
updated_toISODateTimeNo
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": "abc123",
  "sku": ["abc123"],
  "customer_account_id": "abc123",
  "location_name": ["abc123"],
  "location_name_prefix": "abc123",
  "has_inventory": true,
  "location_type_id": ["abc123"],
  "pickable": true,
  "sellable": true,
  "created_from": ISODateTime,
  "created_to": ISODateTime,
  "updated_from": ISODateTime,
  "updated_to": ISODateTime,
  "analyze": true
}

Response

{
  "data": {
    "item_locations": {
      "request_id": "abc123",
      "complexity": 987,
      "data": ItemLocationConnection
    }
  }
}