- Article: A product definition in your catalog created using the Articles API
- Item: A physical unit of inventory stored in a warehouse, created from articles after you send inventory to a warehouse and the inbound completes.
Prerequisites
Before you start, make sure you have:- Session token: A valid session token. See the Authentication guide to learn how to obtain one.
- Seller ID: Use the
GET /sellers endpointto find it. - Warehouse ID: Use the
GET /warehouses endpointto list available warehouses. - Completed inbound: You should have sent inventory and the inbound status should be
COMPLETED. See the Send Inventory guide if you have not sent inventory yet. - Articles created: Products must exist as articles. See the Create Products guide if you have not created articles yet.
All API examples in this guide use
${BASE_URL} as a placeholder. Replace it with the correct base URL configured for the correct environment. For more information see Environments page.Check stock levels by warehouse
To check stock levels for all items in a specific warehouse, use theGET /items/{warehouseId}/{sellerId} endpoint. This returns a list of all items in the warehouse with their current inventory levels. Replace the placeholders with your actual warehouse ID and seller ID.
- Request
- Response
Use this request to list all items and their stock levels in a specific warehouse.
Filter and search items
You can use query parameters to filter and search items:query: Search query string to filter results across multiple fields, for example SKU or namesort: Sort criteria, for examplequantity:descto sort by quantity descendingpage: Page number for paginationpageSize: Number of items per page
Get item details
To get detailed information about a specific item, use theGET /items/{itemId} endpoint. Use the itemId from the item list response.
- Request
- Response
Use this request to retrieve detailed information for a single item.
View item movements and history
To view the movement history for a specific item, use theGET /items/{itemId}/movements endpoint. This shows all movements (inbound, outbound, adjustments) for the item. Use the itemId from the item details.
- Request
- Response
Use this request to retrieve movement history for a specific item.
Filter movements by date range
You can filter movements by date range using themovementFrom and movementTo query parameters:
View item history by warehouse
To view item history for all items in a warehouse, use theGET /items/itemHistories/{warehouseId}/{sellerId} endpoint. This provides a comprehensive history of all item movements in the warehouse. You can use query parameters like query and sort to filter and sort the results.
- Request
- Response
Use this request to retrieve movement history for all items in a warehouse:
Refresh inventory data
If you notice discrepancies between your records and the warehouse inventory, you can trigger a refresh operation to sync inventory data with the warehouse system.Refresh a specific item
To refresh a specific item, use thePOST /items/{itemId}/refresh endpoint. This operation syncs the item’s inventory data with the warehouse system.
- Request
- Response
Use this request to refresh inventory data for a specific item.
Refresh all seller items
To refresh inventory for all items belonging to a seller, use thePOST /items/seller/{sellerId}/refresh endpoint. This operation syncs all items for your seller account with the warehouse system.
- Request
- Response
Use this request to refresh inventory data for all items for a seller.
Where to go next
Now that you can monitor inventory, continue with these guides:Create a Fulfillment Order
Create orders to fulfill customer purchases. Use inventory levels to ensure products are available before creating orders.
Track an Order
Monitor order status and retrieve tracking information when Quivo ships orders from the warehouse.