simple.developersExplore API
PUBLIC API · SANDBOX PREVIEW

Build on
Simple.

A focused API for the workflows that matter to your business. Start with secure, tenant-scoped inventory reporting in the sandbox—and build toward your own tools, reports, and commerce experiences.

Explore the API Get started
No shared credentials. Every key is scoped to your tenant and stores.
simple / sandbox READ-ONLY
REQUEST
GET/api/v1/public/reports/inventory
Authorization: Bearer $SANDBOX_API_KEY
store_id: $STORE_ID
RESPONSE200 OK
{
  "data": [
    { "sku": "SKU-001", "quantity": "12.0000", "low_stock": false }
  ],
  "page": { "has_more": false, "next_cursor": null }
}
API v1 preview ↳ sandbox only
◇Scoped by designOnly the access an integration needs
▧Tenant isolatedStore boundaries on every request
↺Built for testingSandbox keys and data stay separate
THE PLATFORM

Your workflows.
Your way.

We are opening the right capabilities in deliberate stages. The reference lists only operations you can actually use today.

01 / MODULEAVAILABLE IN SANDBOX

Inventory reporting

Read current stock by store, follow cursor-based pages, and spot low-stock variants without exposing internal product records.

View endpoint
02 / MODULEPLANNED

Register closing

Build your own closing workflow around counts, approvals, and reconciliation once the public domain rules are ready.

Read the roadmap
03 / MODULEPLANNED

E-commerce

Sync a published catalog, check availability, and create safe, server-priced orders in a later public API slice.

Read the roadmap
FROM ZERO TO FIRST REQUEST

Three steps.
One clean connection.

Start in an isolated sandbox. Your API key is shown once, bound to your tenant, and can be revoked without affecting other integrations.

Read the getting-started guide
01

Get a sandbox key

Ask a fully signed-in store owner to issue a REST key with reports:inventory:read.

02

Choose a permitted store

Use a store in your sandbox tenant; the key may be restricted to an allowlist.

03

Make a request

Use the interactive reference or send a server-to-server request with your key.