The List Inventory Quantity endpoint allows you to access product inventory quantity data from authorized inventory sources. The response from this API provides structured inventory information by product, source, and warehouse, including available quantity, purchase order quantity, backordered quantity, on-order quantity, in-transit quantity, allocated quantity, stock status, and the last updated timestamp.
Before using this endpoint, please complete the setup steps in the Skulytics Integration Guide: https://docs.skulytics.io/reference/skulytics-integration-guide.
This endpoint cannot be used immediately without setup. Users must register and complete the required integration process before inventory source access can be authorized.
Use Case
This API is useful for accessing and organizing inventory quantity data across multiple inventory sources and warehouses. Types of inventory data may include:
- Available quantity
- Purchase order quantity
- Backordered quantity
- On-order quantity
- In-transit quantity
- Allocated quantity
- Warehouse-level stock status
- Source-level inventory availability
This inventory data can be displayed on e-commerce platforms, product detail pages, dealer portals, internal inventory dashboards, or used in any system that requires up-to-date inventory visibility.
Setup Requirement
Before calling this endpoint, users must complete the Skulytics integration setup process.
The setup is required because inventory data is source-specific and may require authorization before access is granted. The API response includes metadata about which requested sources are authorized or unauthorized for the current integration.
| Requirement | Description |
|---|---|
| Integration setup | Users must complete the setup steps in the Skulytics Integration Guide before using this endpoint. |
| Source authorization | Inventory sources must be authorized before their inventory data can be returned. |
| Registered access | The endpoint requires the user or system to be registered for inventory integration access. |
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
