Sign in
Item

TO BE REMOVED 10/13/2023 - Receive inventory against a specific item.

Use /inventory/receive API instead

post/api/items/{itemId}/inventory/receive

Path parameters

itemIdstring required

Request body

secondaryType'pick' | 'receive' | 'override' | 'revert' | 'deposit' | 'create' | 'consume' | 'ship' | 'sold' | 'transferOut' | 'transferIn' | 'found' | 'expired' | 'damaged' | 'lost' | 'returnVendor' | 'returnStock' | 'receivedNoPo' | 'returnIncrease' | 'returnDecrease' | 'otherIncrease' | 'otherDecrease' | 'scrap' | 'waste' | 'transferredFromSalesOrder' | 'overrideItemValue' | 'transferFromLot' | 'transferToLot' | 'stockAdjustmentIncrease' | 'stockAdjustmentDecrease' | 'stockTake' required

Secondary, verbose description for an event.

lotIdstring nullable

Lot identifier for this block of inventory.

locationIdstring nullable

Location id that inventory is placed into.

quantitynumber double nullable

Location id that inventory is placed into.

actionDatestring date-time nullable

The moment in time where this inventory event action occurs. If not provided, this will default to the current date/time.

source'purchaseOrder' | 'job' | 'shipment' | 'shipmentLineItem' | 'shipping' | 'receiving' | 'item' | 'workOrder' | 'salesOrder' | 'jobOperation' | 'workOrderOperation' | 'fulfillment' | 'itemToMakeMaterialRemnant' | 'poRcvValueAdj'

Indicator for the initial source of the event.

urlstring uri nullable

The source url of the event.

relatedSource'purchaseOrder' | 'job' | 'shipment' | 'shipmentLineItem' | 'shipping' | 'receiving' | 'item' | 'workOrder' | 'salesOrder' | 'jobOperation' | 'workOrderOperation' | 'fulfillment' | 'itemToMakeMaterialRemnant' | 'poRcvValueAdj'

Indicator for the initial source of the event.

relatedEntityIdstring nullable

Entity id for tying this event back to a related entity.

notestring nullable

Notes associated to this transaction.

Response

Inventory transaction processed

Changes

No recorded changes to this endpoint across all 13 revisions of this API.