List the cylinders a customer is holding
GET
/customers/{id}/holdings
const url = 'https://example.com/customers/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/holdings';const options = { method: 'GET', headers: {cookie: '__Host-bottle.session_token=<__Host-bottle.session_token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/customers/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/holdings \ --cookie __Host-bottle.session_token=<__Host-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. A null balanceConfirmedAt means this is only the activity recorded in Bottle and may exclude cylinders held before Bottle. The balance drives deposits, rent and collection suggestions.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
UUID v7
string format: uuid
Example
019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8fUUID v7
Responses
Section titled “Responses”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
openingBalanceQuantity
required
integer
balanceConfirmedAt
required
string | null format: date-time
Example
{ "items": [ { "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f", "gasTypeId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f" } ]}Not signed in
Media typeapplication/json
object
error
required
string
message
required
string
Example
{ "error": "not_found", "message": "Customer not found"}Not a member of that tenant
Media typeapplication/json
object
error
required
string
message
required
string
Example
{ "error": "not_found", "message": "Customer not found"}Not found
Media typeapplication/json
object
error
required
string
message
required
string
Example
{ "error": "not_found", "message": "Customer not found"}Validation failed
Media typeapplication/json
object
error
required
string
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{ "error": "validation", "issues": [ { "path": "email", "message": "Invalid email" } ]}