Skip to main content

InventoryRecord

A day's inventory position for a SKU, at a warehouse or company-wide.

type InventoryRecord {
allocatedQuantity: Int
availableQuantity: Int!
company: Company
companyId: ID!
id: ID!
inStockQuantity: Int
incomingQuantity: Int
note: String
onHandQuantity: Int
period: ISO8601DateTime!
product: InventoryProduct
sku: String!
source: SourceEnum!
warehouseHandle: String!
}

Fields

InventoryRecord.allocatedQuantity ● Int scalar common

Units allocated to orders.

InventoryRecord.availableQuantity ● Int! non-null scalar common

Units available to sell.

InventoryRecord.company ● Company object companies

The company the inventory belongs to.

InventoryRecord.companyId ● ID! non-null scalar common

The company the inventory belongs to.

InventoryRecord.id ● ID! non-null scalar common

Unique identifier of the inventory record.

InventoryRecord.inStockQuantity ● Int scalar common

Physical units minus unavailable (quarantine/damaged).

InventoryRecord.incomingQuantity ● Int scalar common

Units inbound on supply shipments, not yet received.

InventoryRecord.note ● String scalar common

Free-text explanation for the entry, when provided.

InventoryRecord.onHandQuantity ● Int scalar common

Physical units on hand.

InventoryRecord.period ● ISO8601DateTime! non-null scalar common

The day the inventory position corresponds to (UTC).

InventoryRecord.product ● InventoryProduct object common

The product for this SKU, when it exists.

InventoryRecord.sku ● String! non-null scalar common

The SKU.

InventoryRecord.source ● SourceEnum! non-null enum common

Where the row came from.

InventoryRecord.warehouseHandle ● String! non-null scalar common

The warehouse id, or 'unspecified' for imported rows without a warehouse.

Returned By

echoCreateInventoryRecord mutation ● echoUpdateInventoryRecord mutation

Member Of

InventoryRecordConnection object ● InventoryRecordEdge object