Inventory Items

Schema

InventoryItem

Name	Type	Description	Example
id	ID	Unique identifier for inventory items	"ckmnpybisiy5x08abky4g2d1f"
createdAt	DateTime	When this inventory item was created	"2021-03-24 17:26:46.983Z"
updatedAt	DateTime	When this inventory item was updated	"2021-03-24 17:26:46.983Z"
catalogSource	String?	The source of the catalog item	""
description	String?	Description of the inventory item	""
unitPrice	Float?	The price of the inventory item	0
unitsOfMeasure	String?	The unit of measure for the inventory item	""
mpn	String?	The manufacturer part number of the inventory item	""
upc	String?	The universal product code of the inventory item	""
ledgers	InventoryItemLedger[]	The inventory ledgers associated with the inventory item	[]

Queries

inventoryItem

Get a single inventory item by ID.

Parameters

Name	Type	Description
id	ID	ID of the inventory item to fetch

Response

A single InventoryItem.

Example Request

query {
  inventoryItem(id: "ckb91igzt01e90733giki0v0p") {
    id
  }
}

Example Response

{
  "id": "ckb91igzt01e90733giki0v0p",
}

inventoryItems

Get a list of inventory items.

Parameters

Accepts all standard pagination parameters.

Allowed orderBy fields: createdAt, id, updatedAt.

Allowed filter fields: createdAt, id, catalogId, catalogSource, mpn, upc, updatedAt.

Response

A list of InventoryItems objects.

Example Request

query {
  inventoryItems {
    id
  }
}

Example Response

[
  {
    "id": "ckb91igzt01e90733giki0v0p",
  }
]