Skip to content
Skunivo Help Center

Get an inventory balance in the selected organization

GET
/v1/organizations/{organizationId}/balances/{balanceId}

API key scope: inventory:read.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
balanceId
required
string

Header Parameters

Section titled “Header Parameters”
X-Request-Id
string

Optional client request id returned in structured errors.

Responses

Section titled “Responses”

200

Section titled “200”

Inventory balance found.

Media typeapplication/json
object
id
required
string format: uuid
organizationId
required
string format: uuid
environment
required
string
Allowed values: live test
productId
required
string format: uuid
locationId
required
string format: uuid
ownerId
required
string format: uuid
channelId
required
string format: uuid
onHand
required
number
available
required
number
reserved
required
number
committed
required
number
incoming
required
number
damaged
required
number
qualityControl
required
number
safetyStock
required
number
version
required
number
product
object
id
required
string format: uuid
name
required
string
sku
required
string
location
object
id
required
string format: uuid
name
required
string
code
required
string
type
required
string
Allowed values: warehouse store virtual
owner
object
id
required
string format: uuid
name
required
string
code
required
string
type
required
string
channel
object
id
required
string format: uuid
name
required
string
code
required
string
type
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example
{
  "id": "55555555-5555-4555-8555-555555555555",
  "organizationId": "11111111-1111-4111-8111-111111111111",
  "environment": "test",
  "productId": "22222222-2222-4222-8222-222222222222",
  "locationId": "33333333-3333-4333-8333-333333333333",
  "onHand": 10,
  "available": 10,
  "reserved": 0,
  "committed": 0,
  "incoming": 0,
  "damaged": 0,
  "qualityControl": 0,
  "safetyStock": 0,
  "version": 1,
  "product": {
    "id": "22222222-2222-4222-8222-222222222222",
    "name": "Black T-Shirt - Medium",
    "sku": "TSHIRT-BLACK-M"
  },
  "location": {
    "id": "33333333-3333-4333-8333-333333333333",
    "name": "Main Warehouse",
    "code": "MAIN-WH",
    "type": "warehouse"
  },
  "createdAt": "2026-06-29T10:00:00.000Z",
  "updatedAt": "2026-06-29T10:00:00.000Z"
}

403

Section titled “403”

The organization has exhausted its monthly public API request quota.

Media typeapplication/json
Example
{
  "error": {
    "code": "PLAN_LIMIT_EXCEEDED",
    "message": "Plan limit exceeded for api_requests",
    "requestId": "req_123",
    "details": {
      "entitlementKey": "api_requests",
      "scope": "environment",
      "environment": "live",
      "configured": true,
      "limit": "50000",
      "used": "50000",
      "requested": "1",
      "currentPlan": {
        "code": "free",
        "version": 1
      },
      "requiredPlan": {
        "code": "starter",
        "version": 1,
        "requiresOverride": false
      }
    }
  }
}