Record an opening cylinder balance

POST

/customers/{id}/holdings/batch

curl --request POST \
  --url https://example.com/customers/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/holdings/batch \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "items": [ { "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f", "quantity": 1, "since": "2026-04-15" } ] }'

Records several cylinder sizes the customer already held before Bottle in one change. Each optional date sets when rent and deposit-refund timing starts. When a date is omitted, Bottle uses the date the customer was added.

Authorizations

• sessionCookie
  stock:write
• apiKey
  stock:write

Parameters

Path Parameters

id

required

UUID v7

string format: uuid

Example

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

UUID v7

Request Body^required

Media typeapplication/json

object

items

required

Array<object>

>= 1 items <= 50 items

object

productId

required

UUID v7

string format: uuid

Example

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

quantity

required

integer

>= 1 <= 1000

since

string format: date

Responses

201

What they are holding now

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

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

409

A product is a charge, not a cylinder, or a day is in the future

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