Items

Items, also known as line items, are the individual itemized costs on an Order.

Schema

Item

Name	Type	Description	Example
id	ID	Unique identifier for this item	"ckmnpybisiy5x08abky4g2d1f"
backorderLeadTime	DateTime?	Lead time for a backordered item	"2021-03-24 17:26:46.983Z"
backorderQuantity	float?	Amount on backorder for a backordered item	20.0
createdAt	DateTime	When this item was created	"2021-03-24 17:26:46.983Z"
description	string?	Description of the item	3/4" EMT
extPrice	float?	EXT Price of the item	125.00
glCode	GLCode?	GL Code of the item (includes only the id and code fields)	See GL Code docs
lineNumber	int	Number representing the index of the line item within it's order	3
manufacturer	string?	Name of the manufacturer for this item	"Dan's Manufacturing"
manufacturerPartNumber	string?	Manufacturer part number for this item (MPN)	"34857653"
needByDate	DateTime?	When this item is needed by	"2021-03-24 17:26:46.983Z"
notes	string?	Additional handwritten details attached to this item	"This is for me"
orderId	ID?	ID of the order this item is attached to, if attached to one	"ckmnpybisiy5x08abky4g2d1f"
quantity	float?	Quantity of this item	100
taxCode	TaxCode?	Tax code of the item (includes only the id, code, taxPercent fields)	See Tax Code docs
unitDiscount	float?	Discount being applied to the item (precision of 13)	1.25
unitPrice	float?	Unit price of the item	1.25
unitsOfMeasure	string?	Unit of measurement for this item	FT
universalProductCode	string?	Universal product code for this item (UPC)	"98763425"
updatedAt	DateTime	When this item was last updated	"2021-03-24 17:26:46.983Z"
vendorPartNumber	string?	Part number for this item in the vendor's catalog	"438076873"
customColumnValue	string?	Value associated with the custom column	"438076873"

REST Endpoints

GET /items/:id

Get a single item by ID.

Parameters

Name	Type	Description
id	ID	Unique identifier for this item

Response

A single Item.

Example Request

GET https://api.kojo.tech/items/ckb91igzt01e90733giki0v0p

Example Response

{
  "backorderLeadTime": null,
  "backorderQuantity": null,
  "createdAt": "2020-06-10T07:37:04.646Z",
  "description": "3/4\" EMT",
  "extPrice": null,
  "id": "ckb91igzt01e90733giki0v0p",
  "lineNumber": 1,
  "manufacturer": null,
  "manufacturerPartNumber": "",
  "needByDate": null,
  "notes": null,
  "quantity": 2000,
  "unitDiscount": null,
  "unitPrice": null,
  "unitsOfMeasure": "ft",
  "universalProductCode": null,
  "updatedAt": "2020-06-10T07:37:04.646Z",
  "orderId": "ckb91igzr01e70733dehis81o"
}

GET /orders/:id/items

Read the items associated with an order.

Parameters

Accepts all standard pagination parameters.

Allowed orderBy fields: backorderLeadTime, createdAt, id, lineNumber, needByDate, universalProductCode, updatedAt

Default (direction, orderBy): (lineNumber, ASC)

Allowed filter fields: backorderLeadTime, createdAt, id, needByDate, universalProductCode, updatedAt, vendorPartNumber.

Response

A list of Item objects.

Example Request

GET https://api.kojo.tech/orders/ckb91ig8400d307335u4p92lq/items

Example Response

[
  {
    "backorderLeadTime": null,
    "backorderQuantity": null,
    "createdAt": "2020-06-10T07:37:04.646Z",
    "description": "3/4 inch",
    "extPrice": null,
    "id": "ckb91igzt01e90733giki0v0p",
    "lineNumber": 1,
    "manufacturer": null,
    "manufacturerPartNumber": "",
    "needByDate": null,
    "notes": null,
    "quantity": 2000,
    "unitDiscount": null,
    "unitPrice": null,
    "unitsOfMeasure": "ft",
    "universalProductCode": null,
    "updatedAt": "2020-06-10T07:37:04.646Z",
    "orderId": "ckb91ig8400d307335u4p92lq",
    "vendorPartNumber": "12634534"
  }
]