v2

latestOpenAPI 3.0.42026-08-084694591.6 MB

Accounting Code3

Attachment7

Attachment Certification1

Auth1

CAPAs2

Chart Of Accounts2

Company Info2

Custom Field2

Customer6

Customer Address5

Customer Contact5

Customer Tier2

Department4

Equipment4

Gauge Code2

Grade Code2

InProcessTrackingFieldType2

Inventory6

Inventory Event2

Inventory Event Details3

Inventory Lot3

Inventory Transactions1

Invoice5

Invoice Deposit Adjustment Line Item2

Invoice Deposit Line Item2

Invoice Discount Line Item1

Invoice Fee Line Item4

Invoice Line Item2

Invoice Note1

Invoice Part Line Item4

Invoice Refund Line Item4

Invoice Shipping Charge Line Item1

Invoice Tax Line Item2

Item10

Item Category2

Item Class2

Item Custom Fields2

Item Customer4

Item Material Vendor3

Item PriceBreaks4

Item Routing26

Item Tag5

Item Vendor3

Job8

Job Custom Fields2

Job Full Routing18

Job Item To Make3

Job Item To Make Operation8

Job Operation1

Job Part Line Item Full Routing1

Job Tracking Timers3

Location3

Material4

Material Code2

Material Vendor6

NCRs2

Note3

Operation4

Payment Term3

Purchase Order7

Purchase Order Custom Fields2

Purchase Order Discount Line Item1

Purchase Order Fee Line Item7

Purchase Order Line Item3

Purchase Order Outside Processing Line Item7

Purchase Order Part Line Item7

Purchase Order Tax Line Item2

Purchase Order Vendor Credit Line Item4

Quote10

Quote Custom Fields2

Quote Discount Line Item3

Quote Fee Line Item5

Quote Part Line Item7

Quote Part Line Item Custom Fields2

Quote Part Line Item Full Routing19

Quote Tax Line Item5

Receiving Receipt5

Receiving Receipt Line Item5

Refund Reason Code2

Reporting9

Sales Order7

Sales Order Blanket Line Item4

Sales Order Custom Fields2

Sales Order Discount Line Item3

Sales Order Fee Line Item6

Sales Order Line Item2

Sales Order Part Line Item8

Sales Order Part Line Item Custom Fields2

Sales Order Part Line Item Full Routing19

Sales Order Refund Line Item4

Sales Order Shipping Charge Line Item1

Sales Order Tax Line Item5

ScrapReport1

Shape Code2

Shipment Custom Fields1

Shipment Line Items (V3)1

Shipments4

Shipping Method2

Tag5

Tax Rate4

Time Clock Timers3

Timer4

Tool8

Tool Calibration5

User2

User Status2

Vendor5

Vendor Address5

Vendor Contact5

Work Order2

WorkCenter4

Item

Find items based on search parameters.

post/api/items/list/v2

Query parameters

Sort.Fieldstring

Sort field

Sort.Dir'ascending' | 'descending'

Specify sorting direction.

Sort direction

Skipinteger

Number of records to skip.

Takeinteger

Number of records to return (maximum)

Request body

latestRevisionboolean

Indicate whether we want the latest revision(s) of the items.

itemIdsstring[] nullable

Filter to items whose ids are in the list

descriptionFilterstring nullable

Filter items by description. Use (escaped) double-quotes to filter by exact phrase, e.g., \"search phrase\". Prepend search term with "-" to exclude

isArchivedboolean nullable

Include or exclude archived items

includeUsageDataboolean

If set to true, data on where the item is being used will be included in the results

includeVendorDataboolean

If set to true, vendor details about the item will be included in the results

includeCustomerDataboolean

If set to true, customer details about the item will be included in the results

includeCustomerTierDataboolean

If set to true, customer tier details about the item will be included in the results

vendorIdstring nullable

If provided, filter to items that are produced by this vendor.

Response

List of items matching the filters

idstring required

numberstring required

The number to give the item.

descriptionstring required

The description to give the item.

unitTypeNamestring required

The unit of measure type, ex: Piece, Volume or Weight

unitOfMeasureNamestring required

The unit of measure name. Options available depend on the selected UnitTypeName. For Pieces, you might have a UOM of Piece, Set or Case. For Volume, options include Liter, Milliliter, etc.

barCodeNumberstring nullable

The barcode number to give the item.

isSellableboolean

Define if this item is able to be sold/sellable.

isArchivedboolean

Indicate if this item is archived.

isNonInventoryboolean

Indicate if this item is considered a non-inventory item.

accountingCodeIdstring nullable

Accounting code key identifier. Please reference /api/accounting-codes endpoint.

accountingCode2Idstring nullable

Accounting code 2 key identifier. Please reference /api/accounting-codes endpoint.

materialCodeIdstring nullable

Item material code key identifier. Please reference /api/material-codes endpoint.

gradeIdstring nullable

Item grade code key identifier. Please reference /api/grade-codes endpoint.

shapeIdstring nullable

Item shape code key identifier. Please reference /api/shape-codes endpoint.

gaugeIdstring nullable

Item gauge code key identifier. Please reference /api/gauge-codes endpoint.

categoryIdstring nullable

Item category code key identifier. Please reference /api/item-categories endpoint.

widthnumber double nullable

Item width

heightnumber double nullable

Item height

lengthnumber double nullable

Item length

weightnumber double nullable

Item weight

materialWeightnumber double nullable

The weight of material item (calculated)

minimumStockOnHandnumber double nullable

Item minimum stock on hand.

minimumProductionQuantitynumber double nullable

Item minimum production quantity for a manufacturing run.

customFieldsobject nullable

Custom fields that have been defined on this entity.

internalNotesstring nullable

Internal item notes.

externalReferencesobject nullable

External references associated with this entity.

isTaxableboolean nullable

Whether this item is taxable

buildToOrderboolean nullable

Whether or not this item is build to order (jobs are made from sales orders, not overall demand)

buildToStockboolean nullable

Whether or not this item is build to stock (jobs are created from overall demand, not sales orders)

isSingleUseItemboolean nullable

Indicate if this item is intended for single use.

isLotTrackedboolean nullable

Indicate if this item is lot-tracked.

createdUtcstring date-time

The date the item was created

modifiedUtcstring date-time

The date the item was last modified

qualityPlanStatus'needsApproval' | 'approved'