Skip to main content
GET
/
products
/
{id}
/
inventory
Get inventory totals and by-location breakdown for a product (dual scope)
curl --request GET \
  --url https://api.arcuserp.com/v1/products/{id}/inventory \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "on_hand": 123,
    "allocated": 123,
    "available": 123,
    "total_value": 123,
    "by_location": [
      {
        "location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "location_name": "<string>",
        "on_hand": 123,
        "allocated": 123,
        "available": 123
      }
    ]
  }
}

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

location_id
string<uuid>

Optional Layer 4 location filter

Response

Inventory totals and by-location breakdown

data
object