Skip to content
Bottle

The stock report

GET
/stock/report
curl --request GET \
  --url 'https://example.com/stock/report?from=2026-04-15&to=2026-04-15' \
  --cookie bottle.session_token=<bottle.session_token>

Over a span of days: what came in and went out per product, every customer holding cylinders of yours and for how long, and per driver what the plan called for against what was actually loaded.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
from
required
string format: date
to
required
string format: date

Responses

Section titled “Responses”

200

Section titled “200”

The report

Media typeapplication/json
object
from
required
string format: date
to
required
string format: date
turnover
required
Array<object>
object
productId
required

UUID v7

string format: uuid
productName
required
string
shortCode
required
string | null
received
required
integer
delivered
required
integer
collected
required
integer
sentForRefill
required
integer
damaged
required
integer
adjusted
required
integer
out
required
Array<object>
object
customerId
required

UUID v7

string format: uuid
customerName
required
string
productId
required

UUID v7

string format: uuid
productName
required
string
quantity
required
integer
> 0
since
required
string format: date-time
daysOut
required
integer
loading
required
Array<object>
object
driverUserId
required

UUID v7

string | null format: uuid
driverName
required
string | null
rounds
required
integer
confirmed
required
integer
planned
required
integer
loaded
required
integer
broughtBack
required
integer
Example
{
  "turnover": [
    {
      "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
    }
  ],
  "out": [
    {
      "customerId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
    }
  ],
  "loading": [
    {
      "driverUserId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
    }
  ]
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not a member, or without the permission this needs

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}