List Product Inventory Quantity

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.

RequirementDescription
Integration setupUsers must complete the setup steps in the Skulytics Integration Guide before using this endpoint.
Source authorizationInventory sources must be authorized before their inventory data can be returned.
Registered accessThe endpoint requires the user or system to be registered for inventory integration access.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
source
array of strings
required

Distributor source used to retrieve inventory data. Example: ADC or DMI. The client must be authorized to access the requested source.

source*
string

SKU to search. If provided, the API returns data only for the requested SKU. If not provided, the API returns SKUs based on the selected source and access rules.

string

Match behavior for sku searches. Allowed values: exact or fuzzy. (Default: exact if not provided.)

boolean

If true, a single hit can access all SKUs available in the distributor. If false, a single hit will display only 10 SKUs by default.

warehouse_name
array of strings

Limits results to specific warehouse names.

warehouse_name
boolean

If true, only returns warehouse records where inventory.available_qty > 0.

integer

Maximum number of page availability to be shown.

string

Used for searching the specific page.

Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json