Skip to main content
GET
/
inventory
/
balances
List inventory balances
curl --request GET \
  --url https://api.arcuserp.com/v1/inventory/balances \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "id": "inv-bal-uuid-0001",
      "entity_id": "ent-uuid-here",
      "product_id": "prod-uuid-0001",
      "location_id": "loc-uuid-0001",
      "variant_id": null,
      "on_hand": 150,
      "allocated": 20,
      "available": 130,
      "on_purchase_order": 50,
      "total_value": 2775,
      "avg_unit_value": 18.5,
      "product_title": "Widget Pro XL",
      "location_name": "Main Warehouse",
      "created_at": "2025-06-01T12:00:00Z",
      "updated_at": "2026-05-01T08:00:00Z"
    }
  ],
  "total": 1,
  "page": 1,
  "per_page": 25,
  "total_pages": 1
}

Documentation Index

Fetch the complete documentation index at: https://docs.arcuserp.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Query Parameters

​
product_id
string<uuid>
​
location_id
string<uuid>

Layer 4 location filter

​
variant_id
string<uuid>
​
low_stock_only
boolean
​
page
integer
default:1
Required range: x >= 1
​
per_page
integer
default:25
Required range: 1 <= x <= 100
​
expand[]
enum<string>[]
Available options:
data.product,
data.location,
data.lot

Response

List of inventory balances

​
object
enum<string>
Available options:
list
​
data
object[]
​
total
integer
​
page
integer
​
per_page
integer
​
total_pages
integer