Skip to main content
GET
Get Inventory Logs

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Path Parameters

stock_id
string
required

Query Parameters

action_types
enum<string>[] | null
Available options:
STOCK_CREATED,
STOCK_UPDATED,
STOCK_ARCHIVED,
DRAWDOWN,
RESTORED,
SHIPMENT_RECEIVED,
SHIPMENT_UPDATED,
SHIPMENT_ARCHIVED,
ITEM_LINKED,
ITEM_UNLINKED

Response

Successful Response

stockId
string
required

ID of the stock

action
enum<string>
required

Action performed on the stock

Available options:
STOCK_CREATED,
STOCK_UPDATED,
STOCK_ARCHIVED,
DRAWDOWN,
RESTORED,
SHIPMENT_RECEIVED,
SHIPMENT_UPDATED,
SHIPMENT_ARCHIVED,
ITEM_LINKED,
ITEM_UNLINKED
creatorId
string
required

ID of the creator

id
string

Unique identifier for the inventory log

itemId
string | null

ID of the item

quantity
number | null

Quantity of the stock

chargeId
string | null

ID of the charge

createdDate
string<date-time> | null

Date and time the log was created

shipmentId
string | null

ID of the shipment

note
string | null

Optional note about the inventory action

stock
StockTiny · object | null

Stock

item
Item · object | null

Item

charge
ChargeSummary · object | null

Charge

shipment
Shipment · object | null

Shipment

creator
UserTiny · object | null

Creator