get https://example.com/api/v0/inventory/transactions
The Inventory Transactions Endpoint is used to return a paginated list of records of transactions for a productId. You can specify a date range, but the default will be a window of 31 days.
Field | Contents |
---|---|
productId | Unique identifier assigned to the product |
partNumber | Part Number |
upc | Universal Product Code (UPC) |
ean | European Article Number (EAN) |
transactionLocation | The FC location code of the transaction (ex: LAS01) |
transactionDate | The exact date and timestamp when the transaction was processed |
expectedArrivalDate | When the product is expected to arrive |
inventoryAdjustmentType | The type of inventory adjustment made. Ex: “Sale”, “FC Transfer” |
saleId | Obsolete (will be removed) |
customerOrderId | Order ID provided when calling the Create Orders endpoint |
customerLineItemId | The customerLineItemId provided when calling the Create Orders endpoint |
poDetail | Information about the product purchase order |
containerNumber | The identifier for the shipping container in which the products are transported |
quantity | The amount of units of the item in the transaction |
tracking.trackingNumber | Tracking number associated with the customerLineItemId |
tracking.shippingCarrier | The Shipping Carrier code. See "Get Tracking Updates" for available options. |
tracking.serviceLevel | The Service Level used to ship the customerLineItemId |
tracking.shipDate | Tracking number generation date, in UTC |
tracking.originFc | The origin fulfillment center for the customerLineItemId |
Sample Data Response
"inventoryTransactions": [
{
"productId": "408400",
"partNumber": "CS-ClRESa100B-BE-2P",
"upc": "6972228208145",
"ean": "1234567890123",
"transactionLocation": "SAV01",
"transactionDate": "2024-10-25T19:07:28.330Z",
"expectedArrivalDate": "2024-10-25T19:07:28.330Z",
"inventoryAdjustmentType": "Sale",
"customerOrderId" : "string",
"customerLineItemId" : "string",
"poDetail": "Here are some details",
"containerNumber": "3231111",
"quantity": 93,
"tracking": [
{
"trackingNumber": "string",
"shippingCarrier": "string",
"serviceLevel": "string",
"originFc": "string",
"shipDate": "2025-01-13T19:15:01.296Z"
}
]
}
],
inventoryAdjustmentType | Description |
---|---|
Sale | Outbound Sales order adjustment |
FC Transfer | This includes multiple transactions, internal FC moved for shipment transaction, FC to FC transaction, and receiving FC moved from receipt to inventory. There will be a decrement from the originating FC and an addition to the receiving FC. |
Damaged | This is for any inventory damaged while in an active inventory held status, for example damaged in warehouse. |
Quality Control | This is quality control adjustments for lost or found inventory. |
Container Shipped | When Spreetail has shipping information for container loads we will provide an update that the container was shipped from origin. |
Domestic Inbound Shipped | When Spreetail receives advanced shipping notification of domestic inbound shipments this will show that the shipment has been shipped from origin. |
Container Checked-In | When Spreetail checks the container into our yard. |
Domestic Inbound Checked-In | When Spreetail checks the shipment into our yard. |
Container Received | When Spreetail receives the inventory into our warehouse stock. |
Domestic Inbound Received | When Spreetail receives the inventory into our warehouse stock. |
Returns | Returns received to inventory, including for Return To Sender from carrier, and customer refused delivery. |