Skip to content

skuflo Developers skuflo.iov1 Changelog

Finished goods by bay, ageing and value

GET/v1/stockFactory API keyBase URL api.skuflo.io

Pieces made and stored in a rack bay, not yet loaded (and older pieces booked in stock). Filter to one rack with ?rack=A.

Query parameters#

Name	Type	Description
`rack`optional	`string`	Rack code, e.g. A. Matches every bay on that rack.

Responses#

Status	Meaning
200	Success. An example body is in the column on the right.

Response fields

Name	Type	Description
`summary`	`object`	·
`pieces`	`integer`	·
`under_7`	`integer`	pieces in stock under 7 days
`days_8_14`	`integer`	·
`over_14`	`integer`	·
`avg_days`	`any`	Postgres numeric, comes back as a decimal string
`value_at_cost`	`any`	Postgres numeric, comes back as a decimal string; null with no unit_cost configured
`racks`	`object[]`	·
`code`	`string`	·
`zone`	`string`	·
`bays`	`integer`	·
`bay_capacity`	`integer`	·
`bays`	`object[]`	·
`bay`	`string`	·
`pieces`	`integer`	·
`oldest`	`string (date-time)`	·
`over_7_days`	`boolean`	·

Other errors#

Status	Meaning
401	No key, or the key is not recognised.
429	More than 600 requests a minute. Wait `retry-after` seconds.

Try it

GET /v1/stock

Request

curl "https://api.skuflo.io/v1/stock" \
  -H "Authorization: Bearer sk_live_..."

Response

{
  "summary": {
    "pieces": 12,
    "under_7": 9,
    "days_8_14": 3,
    "over_14": 0,
    "avg_days": 4.2,
    "value_at_cost": null
  },
  "racks": [
    {
      "code": "A",
      "zone": "Upholstery",
      "bays": 12,
      "bay_capacity": 36
    }
  ],
  "bays": [
    {
      "bay": "A3",
      "pieces": 4
    }
  ]
}

Every response carries x-ratelimit-limit, x-ratelimit-remaining and x-ratelimit-reset.