All Collections
Using Inventory Planner
Inventory Planner API
Inventory Planner Reports API
Inventory Planner Reports API
Programmatic way to access your inventory metrics
Jill avatar
Written by Jill
Updated over a week ago

In this article:

When To Use This API

The Reports API is most commonly used to pull data to create custom dashboards or reports. Inventory Planner has over 200 metrics available, and can be queried to create a report outside of Inventory Planner.

Related: existing reports in Inventory Planner can be automated to email selected recipients, and you can learn more here.

Working with Inventory Planner APIs

To get started, refer to the Inventory Planner Public API article for information including authorization and making requests.

API Endpoints

Variants (api/v1/variants) and variant (api/v1/variants/{id})

A variant corresponds to one variation of a product with particular features (for example, color and size) and contains both information downloaded from e-commerce platform and computed by Inventory Planner.

The following fields are currently supported:

  • id - variant identifier (read-only)

  • sku - SKU (read-only)

  • lead_time - lead time

  • review_period - days of stock

  • replenishment - current replenishment number

  • under_value - forecasted lost revenue

  • oos - forecasted number of days to sell out

Variant vendors (api/v1/variants/[id]/vendors) and variant vendor (api/v1/variants/[id]/vendor/[vendor_id]

Each variant has associated list of vendor data. Vendor identifier (vendor_id) is the vendor name converted to low case. The following vendor data fields are available:

  • cost_price - vendor cost price

  • landing_cost_price - vendor landing cost price

  • vendor_reference - vendor reference/sku

  • vendor_name - vendor variant name (title)

  • vendor_packaging - MOQ, minimum order quantity

  • uom_ordering - UOM, units of measurement


Line item received history is an array of the documents with the following fields:

  • date - received date time stamp (in Unix format)

  • value - received qty

Line item components is an array of documents with the following fields:

  • id - component variant id

  • quantity - component quantity required to produce 1 unit of line item's assembly

  • sku - component SKU

  • title - component title

  • barcode - component barcode

API Usage Example

Retrieve SKU, replenishment, and forecasted lost revenue for first 50 variants by forecasted lost revenue

GET /api/v1/variants?fields=sku,replenishment,under_value&under_value_sort=desc&limit=50&page=0

Did this answer your question?