FUfulcrumpro
Item

Find items based on search parameters.

Changed on
post/api/items/list/v2

Request

  • Base URL
    https://api.fulcrumpro.com
  • URL
    https://api.fulcrumpro.com/api/items/list/v2
  • Auth
    none declared

Query parameters

Sort.Fieldstring

Sort field

Sort.Dir'ascending' | 'descending'

Specify sorting direction.

Sort direction

Skipinteger

Number of records to skip. Defaults to 0. Combine with FulcrumProduct.PublicApi.Dto.Common.PagingDto.Take to page through a result set larger than one page.

Takeinteger

Number of records to return. Validation accepts 0 through 5000, but 0 is not a page size and what an endpoint does with it varies, so send a value from 1 to 5000.

Two cases differ. A request that supplies paging but leaves this field out takes this field's default of <b>50</b>. A request that supplies no paging at all is endpoint-specific — some define their own fallback — so it does not reliably mean any particular number of records. Either way the response says nothing about records it did not return, so send this explicitly whenever the size of the answer matters. Endpoints returning a paged envelope report totalCount and hasNextPage alongside the records; endpoints returning a bare array report neither, so page those with FulcrumProduct.PublicApi.Dto.Common.PagingDto.Skip until a page comes back shorter than the value requested.

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 to items whose description contains this text. Matching is a case-insensitive substring test; it is not a phrase or keyword search and supports no operators.

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.

modifiedAfterUtcstring date-time nullable

Filters to items modified at or after (inclusive) this parameter in UTC time. If no time component is passed, midnight UTC will be used. With modifiedBeforeUtc it selects the window [after, before).

modifiedUtc also advances when a file is attached to, removed from, moved onto or off, or rewritten on the item. To poll without missing changes: set modifiedBeforeUtc to the current time minus a short lag (for example two minutes), so in-flight writes have committed. Request the window sorted by modifiedUtc with take of 1000 or less and no skip. If the page is full (it holds take items), the window is too wide: halve it, setting modifiedBeforeUtc to modifiedAfterUtc + (modifiedBeforeUtc - modifiedAfterUtc) / 2, and request again. Otherwise process the page and continue with modifiedAfterUtc set to this window's modifiedBeforeUtc. If a full page holds a single modifiedUtc value, halving cannot narrow it further: page through that one instant with skip and take, since items sharing a modifiedUtc are ordered by id. Deleted items never appear in this list. To learn of deletions, reconcile separately.

modifiedBeforeUtcstring date-time nullable

Filters to items modified before (exclusive) this parameter in UTC time. If no time component is passed, midnight UTC will be used. Each window boundary belongs to exactly one window; choose a lag longer than any write takes to commit, since an item's stamp is its write time, not its commit time.

Response

List of items matching the filters

idstring required

Id

numberstring required

The number to give the item.

descriptionstring required

The description to give the item.

itemOrigin'make' | 'buy' | 'makeOrBuy' | 'customerSupplied' | 'kit' | 'none' required
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'
needsQualityPlanboolean

Whether this item requires an approved quality plan. When true, the item has an approved quality plan only if FulcrumProduct.PublicApi.Dto.Item.ItemDto.QualityPlanStatus is Approved; when false, no quality plan approval is required. Read-only: returned on item reads but not settable through the create/update endpoints.

Changes

  • 2ef5c78c2bcbRevision changes
    • info

      added the new optional request property (media type: application/json-patch+json)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)

    • info

      added the new optional request property (media type: application/json-patch+json)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)

  • c4b2ba5fc270Revision changes
    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: application/problem+json)