Confirm a customer cylinder balance

POST

/customers/{id}/holdings/confirm

const url = 'https://example.com/customers/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/holdings/confirm';
const options = {
  method: 'POST',
  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 POST \
  --url https://example.com/customers/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/holdings/confirm \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token>

Confirms that every cylinder the customer held before Bottle has been entered. A confirmed zero is different from an opening balance that has not been checked.

Authorizations

sessionCookie
stock:write
apiKey
stock:write

Parameters

Path Parameters

required

UUID v7

string format: uuid

Example

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

UUID v7

Responses

200

The confirmed holding

application/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

application/json

object

error

required

string

message

required

string

Example

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

403

Not a member of that tenant

application/json

object

error

required

string

message

required

string

Example

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

404

Not found

application/json

object

error

required

string

message

required

string

Example

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

422

Validation failed

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