Getting Started

What is the Inventra API?

The Inventra API gives your applications programmatic access to inventory, orders, products, purchase orders, stock transfers, and locations. Use it to:

• Sync stock levels from your warehouse or marketplace into Inventra
• Create and fulfill orders from your storefront or POS
• Look up products and variants by SKU or barcode
• Receive webhooks when orders or inventory change

Base URL

All API requests use your organization’s base URL:

https://your-org.inventra.io/api/v1

Replace your-org with your tenant subdomain. For local development, use your tunnel or localhost.

Response envelope

Responses are JSON. Successful responses use a consistent envelope:

{
  "data": { ... },
  "meta": { "page": 1, "per_page": 25, "total": 100 }
}

data holds the resource or list. meta appears on list endpoints for pagination. Errors include an errors array.

Common workflow

A typical integration flow:

1. Obtain an API key from Admin → Settings → API Keys.
2. Authenticate every request with Authorization: Bearer <token>.
3. Read inventory via GET /inventory_levels (optional filters: sku, location_id, updated_since).
4. Create orders with POST /orders, then reserve and fulfill when ready.
5. Use idempotency keys on write requests to safely retry.