Skip to main content
All CollectionsAPI
How Does the WholeCell API Work?
How Does the WholeCell API Work?

Connect WholeCell to your custom applications

Brennan Zelener avatar
Written by Brennan Zelener
Updated over a week ago

WholeCell's API allows customers to build an integration between their WholeCell account and any other custom application.

We envision the API being used for integrations like:

  • Trade-in and Buyback portals

  • Diagnostics/testing software

  • Bulk IMEI check tools

  • Custom e-commerce stores

  • Custom warehouse processing apps


API documentation is hosted here:


Customers can create and manage API Apps from their API Apps Settings page. Each API App has a unique App ID and App Secret for authentication, along with an array of access permissions:



Allows you to create, read, update, and list inventory items with various filters.

Inventory Reports

Allows you to find an inventory report by ID and list the inventory items currently in that report.

Purchase Orders

Allows you to create, read, update, and list Purchase Orders with various filters.

Sales Orders

Allows you to create, read, update, and list Sales Orders with various filters.

Also allows you to download the PDF or Excel export of a Sales Order.

Stock Levels Reports

Stock levels reports allow you to download all stock levels as a CSV via API.

Many sales channels (eBay, Amazon, Walmart, Shopify, etc) have a way to upload a CSV of sku/stock levels either manually or via API.

This endpoint returns an ID of a report when you make a create request, then you can poll the ID until it is complete. Once complete the response includes a URL to download the CSV.

Stock Levels

Lists all SKUs and their quantities in your WholeCell account:

  • "sku" - the SKU in question.

  • "on_hand" - the quantity of inventory of the SKU in question in your WholeCell account under any status which has not been sold on a Sales Order.

  • "outstanding" - the quantity of inventory of the SKU in question on open Sales Orders that have not been committed **this only includes open orders from the last 90 days. older orders will not be counted in this API response**

  • "available" - the on_hand quantity minus the outstanding quantity


We'd love to hear your feedback on the API and learn more about your specific use cases. Please share with us at

Did this answer your question?