Sign in

v2

latestOpenAPI 3.0.42026-08-084694591.6 MB
Inventory Event

Get a specific inventory event

get/api/inventory-events/{inventoryEventId}

Path parameters

inventoryEventIdstring required

Response

The inventory event for the given id

idstring required

Id

actionDatestring date-time nullable

The date of the action.

type'pick' | 'receive' | 'revert' | 'adjustment' | 'setItemValue' | 'eventOverride' required

Primary inventory event type.

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'

Secondary, verbose description for an event.

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

Indicator for the initial source of the event.

sourceNamestring nullable

Source name.

sourceEntityIdstring nullable

Source entity id

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

Indicator for the initial source of the event.

sourceRelatedEntityIdstring nullable

Related source entity id

sourceItemToMakeIdstring nullable

Source item to make id. Please reference /api/jobs/{jobId}/items-to-make endpoint.

itemIdstring nullable

Item id key identifier. Please reference /api/items endpoint.

itemToMakeIdstring nullable

Item to make id key identifier. Please reference /api/jobs/{jobId}/items-to-make endpoint.

quantitynumber double required

Quantity.

reservedForIdstring nullable

This is the id for the underlying entity that this inventory is reserved for.

reservedForType'job' | 'salesOrder' | 'shipment' | 'shipmentLineItem' | 'invoice' | 'invoiceLineItem' | 'customer' | 'customerAddress' | 'item' | 'receivingInspection' | 'failedInspection'
lotIdstring nullable

The lot this inventory is allocated to. Please reference /api/inventory-lots endpoint.

locationIdstring nullable

The location this inventory is allocated to. Please reference /api/locations endpoint.

revertInventoryEventIdstring nullable

If the event is intended to "revert" a previous transaction, this value contains the original event.

notestring nullable

A note associated to this event.