Skip to main content

Inventory Items

Schema​

InventoryItem​

NameTypeDescriptionExample
idIDUnique identifier for inventory items"ckmnpybisiy5x08abky4g2d1f"
createdAtDateTimeWhen this inventory item was created"2021-03-24 17:26:46.983Z"
updatedAtDateTimeWhen this inventory item was updated"2021-03-24 17:26:46.983Z"
catalogSourceString?The source of the catalog item""
descriptionString?Description of the inventory item""
unitPriceFloat?The price of the inventory item0
unitsOfMeasureString?The unit of measure for the inventory item""
mpnString?The manufacturer part number of the inventory item""
upcString?The universal product code of the inventory item""

REST Endpoints​

GET /inventory-items​

Read the list of inventory items

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 Inventory Item objects.

Example Request​

GET https://api.kojo.tech/inventory-items

Example Response​

[
{
"id": "clku7gtqt000cpwtzv6e971xg",
"createdAt": "2021-03-24 17:26:46.983Z",
"updatedAt": "2021-03-24 17:26:46.983Z",
"catalogSource": "",
"description": "3/4\" EMT",
"unitPrice": null,
"unitsOfMeasure": "in",
"mpn": null,
"upc": null,
}
]