Axiomatic
Assets & Inventory

Inventory

Stock items, lots, counts, valuation — read:inventory / write:inventory. Entity-scoped via withTenant; session cookie or Bearer ak_… + entityId query / x-entity-id / JSON on writes.

List inventory (items, transactions, counts, valuation, …)

GET
/api/inventory

Authorization

bearerAuth
AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid
view?string

items | summary | item-options | transactions | counts | count-lines | valuation | lots

Response Body

application/json

application/json

application/json

curl -X GET "https://app.axiomatic.software/api/inventory?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08"
Empty
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}

Inventory actions (receive, issue, create item, …)

POST
/api/inventory

Authorization

bearerAuth
AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://app.axiomatic.software/api/inventory?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "action": "create-item"  }'
Empty
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}

Soft-delete item (discontinued)

DELETE
/api/inventory

Authorization

bearerAuth
AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid
id*string
Formatuuid

Response Body

application/json

application/json

curl -X DELETE "https://app.axiomatic.software/api/inventory?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08&id=497f6eca-6276-4993-bfeb-53cbbbba6f08"
Empty
{
  "error": "string"
}
{
  "error": "string"
}

Update inventory item

PUT
/api/inventory

Authorization

bearerAuth
AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X PUT "https://app.axiomatic.software/api/inventory?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"  }'
Empty
{
  "error": "string"
}
{
  "error": "string"
}