Skip to content
Bottle

List stock movements

GET
/stock/movements
curl --request GET \
  --url 'https://example.com/stock/movements?productId=019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f&limit=100&offset=0' \
  --cookie bottle.session_token=<bottle.session_token>

The movements behind a figure, newest first. Every one says where the stock came from and where it went, so a count nobody expected can be read back to the moment it changed.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
productId

UUID v7

string format: uuid
Example
019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

limit
integer
default: 100 >= 1 <= 500
offset
integer | null
0

Responses

Section titled “Responses”

200

Section titled “200”

Movements

Media typeapplication/json
object
items
required
Array<object>
object
id
required

UUID v7

string format: uuid
productId
required

UUID v7

string format: uuid
productName
required
string
condition
required
string
Allowed values: full empty
quantity
required
integer
> 0
fromKind
required
string
Allowed values: place vehicle customer supplier nowhere
toKind
required
string
Allowed values: place vehicle customer supplier nowhere
fromName
required
string | null
toName
required
string | null
reason
required
string
Allowed values: loaded delivered collected unloaded received sent_for_refill stocktake damaged correction
roundId
required

UUID v7

string | null format: uuid
orderId
required

UUID v7

string | null format: uuid
byName
required
string | null
note
required
string | null
at
required
string format: date-time
total
required
integer
Example
{
  "items": [
    {
      "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "condition": "full",
      "fromKind": "place",
      "toKind": "place",
      "reason": "loaded",
      "roundId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "orderId": "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"
    }
  ]
}