Skip to content
All Alpha Armory Docs

Sparse per-SKU quantity and cost observation history

GET
/v1/catalog/inventory/history
curl --request GET \
  --url 'https://api.oldsteelarsenal.com/v1/catalog/inventory/history?sku=example&distributor=rsr&days=30&limit=100' \
  --header 'x-client-id: <x-client-id>' \
  --header 'x-signature: <x-signature>' \
  --header 'x-timestamp: <x-timestamp>'

Newest ID first; before=next_cursor pages older events. Keep distributor, sku and days unchanged while paging. Unchanged successful samples have no event; last_observed distinguishes them from missing samples. Baselines cannot be interpreted as sales. Scope: catalog:read.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
sku
required
Sku
string
>= 1 characters <= 128 characters
distributor
Distributor
string
default: rsr /^[a-z0-9_]{1,32}$/
days
Days
integer
default: 30 >= 1 <= 365
before
Any of:
integer
>= 1
limit
Limit
integer
default: 100 >= 1 <= 200

Header Parameters

Section titled “Header Parameters”
x-client-id
Any of:
string
x-timestamp
Any of:
string
x-signature
Any of:
string

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
InventoryHistoryResponse
object
distributor
required
Distributor
string
events
required
Events
Array<object>
InventoryEvent
object
baseline
required
Baseline

No delta may be inferred across this observation.

boolean
discontinued
required
Discontinued
boolean
distributor_code
required
Distributor Code
string
id
required
Id
integer
metric
required
Metric
string
Allowed values: qty cost
observed_at
required
Observed At
string format: date-time
previous_observed_at
required
Any of:
string format: date-time
previous_value
required
Any of:
number
run_id
required
Run Id
integer
sku
required
Sku
string
source
required
Source
string
status_flag
required
Status Flag
string
upc
required
Any of:
string
value
required
Value
number
has_more
required
Has More
boolean
last_observed
required
Last Observed
Array<object>
InventoryLastObserved
object
metric
required
Metric
string
Allowed values: qty cost
observed_at
required
Observed At
string format: date-time
next_cursor
required
Any of:
integer
server_time
required
Server Time
string format: date-time
sku
required
Sku
string
window_days
required
Window Days
integer
Example
{
  "events": [
    {
      "metric": "qty"
    }
  ],
  "last_observed": [
    {
      "metric": "qty"
    }
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}