object ItemLocation

Fields

FieldTypeDescription
idString

Public API ID for this identifiable.

legacy_idBigInt

Numeric legacy ID for this identifiable; use only where legacy IDs are required.

account_idString

Public API account ID that identifies the related record.

warehouse_idString

Public API warehouse ID. Use this when passing or filtering by a warehouse; warehouse fields are display values or nested objects.

location_idString

Public API location ID that identifies the related record.

skuString

SKU. SKU matching is case-insensitive and ignores surrounding whitespace.

quantityInt

Total quantity in this item location, including units stored inside LPNs.

loose_quantityInt

Quantity in this item location that is not inside an LPN.

allocated_quantityInt

Quantity in this item location allocated to orders.

created_atISODateTime

Date when the SKU was first associated with this location (bin).

updated_atISODateTime

Date of the last modification to this item-location record (e.g. stock adjustments, lot changes).

locationLocation

Location for this item location.

location_typeLocationType

Location type for this item location.

expiration_lotLot

Expiration lot for this item location.

lpnsLicensePlateNumberConnection

Lpns for this item location.

ArgumentTypeRequiredDefaultDescription
sortStringNo
beforeStringNo
afterStringNo
firstIntNo
lastIntNo
productProduct

Product associated with this item location.

warehouse_productWarehouseProduct

Warehouse product associated with this item location.

Referenced By

Example

{
  "id": "UmVjb3JkOjEyMzQ=",
  "legacy_id": 1234,
  "account_id": "QWNjb3VudDoxMjM0",
  "warehouse_id": "V2FyZWhvdXNlOjEyMzQ=",
  "location_id": "TG9jYXRpb246MTIzNA==",
  "sku": "BLUE-TEE-M",
  "quantity": 2,
  "loose_quantity": 2,
  "allocated_quantity": 2,
  "created_at": "2026-07-09T15:30:00Z",
  "updated_at": "2026-07-09T15:30:00Z",
  "location": {id: "TG9jYXRpb246MTIzNA==", name: "A01-01-01"},
  "location_type": {id: "TG9jYXRpb246MTIzNA==", name: "A01-01-01"},
  "expiration_lot": {id: "TG9jYXRpb246MTIzNA==", name: "A01-01-01"},
  "lpns": [{id: "TG9jYXRpb246MTIzNA==", name: "A01-01-01"}],
  "product": {sku: "BLUE-TEE-M", name: "Blue Tee"},
  "warehouse_product": {sku: "BLUE-TEE-M", name: "Blue Tee"}
}