Skip to main content
GET
/
inventory
/
balances
/
{id}
Get a single inventory balance
curl --request GET \
  --url https://api.arcuserp.com/v1/inventory/balances/{id} \
  --header 'Authorization: Bearer <token>'
{
  "object": "inventory_balance",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "variant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "on_hand": 123,
    "allocated": 123,
    "available": 123,
    "on_purchase_order": 123,
    "total_value": 123,
    "avg_unit_value": 123,
    "product_title": "<string>",
    "location_name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

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.

Path Parameters

​
id
string<uuid>
required

Query Parameters

​
expand[]
enum<string>[]
Available options:
product,
location,
lot

Response

Single inventory balance

​
object
enum<string>
Available options:
inventory_balance
​
data
object

Per-product per-location inventory balance. available is readOnly.