Inventory Planner

The Reports API is most commonly used to pull data to create custom dashboards or reports. Inventory Planner has over <a href="https://help.inventory-planner.com/en/articles/1040319-glossary-of-terms">200 metrics available</a> which 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 <a href="https://help.inventory-planner.com/en/articles/5807037-email-and-automate-reports">learn more here.</a>

To get started, refer to the <a href="https://help.inventory-planner.com/en/articles/674662-inventory-planner-public-api">Inventory Planner Public API article</a> for information including authorization and making requests.

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:

<code>id</code> - variant identifier (read-only)

<code>review_period</code> - days of stock

<code>replenishment</code> - current replenishment number

<code>oos</code> - forecasted number of days to sell out

- <code>id</code> - variant identifier (read-only) 
- <code>sku</code> - SKU (read-only)
- <code>lead_time</code> - lead time 
- <code>review_period</code> - days of stock
- <code>replenishment</code> - current replenishment number
- <code>oos</code> - 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 an associated list of vendor data. The vendor identifier (vendor_id) is the vendor name converted to lower case. The following vendor data fields are available:

<code>cost_price</code> - vendor cost price

<code>landing_cost_price</code> - vendor landing cost price

<code>vendor_reference</code> - vendor reference/sku

<code>vendor_name</code> - vendor variant name (title)

<code>vendor_packaging</code> - MOQ, minimum order quantity

<code>uom_ordering</code> - UOM, units of measurement

- <code>cost_price</code> - vendor cost price
- <code>landing_cost_price</code> - vendor landing cost price 
- <code>vendor_reference</code> - vendor reference/sku
- <code>vendor_name</code> - vendor variant name (title)
- <code>vendor_packaging</code> - MOQ, minimum order quantity
- <code>uom_ordering</code> - UOM, units of measurement

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

<code>date</code> - received date time stamp (in Unix format)

- <code>date</code> - received date time stamp (in Unix format) 
- <code>value</code> - received qty

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

<code>quantity</code> - component quantity required to produce 1 unit of line item's assembly

- <code>id</code> - component variant id
- <code>quantity</code> - component quantity required to produce 1 unit of line item's assembly
- <code>sku</code> - component SKU
- <code>title</code> - component title
- <code>barcode</code> - component barcode

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

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

When to use this API

Working with Inventory Planner's APIs

API endpoints

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

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

API usage example

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

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