List the cylinders a customer is holding

GET

/customers/{id}/holdings

curl --request GET \
  --url https://example.com/customers/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/holdings \
  --cookie bottle.session_token=<bottle.session_token>

How many of ours they have, per product, and when the oldest of them went out. Out to them less back from them, from the stock movements. What a deposit is owed against, what a weekly hire is charged on, and what decides whether a new order needs a cylinder charge putting on it.

Authorizations

• sessionCookie
  stock:read
• apiKey
  stock:read

Parameters

Path Parameters

id

required

UUID v7

string format: uuid

Example

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

Responses

200

What they are holding

Media typeapplication/json

object

items

required

Array<object>

object

productId

required

UUID v7

string format: uuid

productName

required

string

gasTypeId

required

UUID v7

string | null format: uuid

quantity

required

integer

since

required

string | null format: date-time

Example

{
  "items": [
    {
      "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "gasTypeId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
    }
  ]
}

401

Not signed in

Media typeapplication/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Not a member of that tenant

Media typeapplication/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

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"
    }
  ]
}