Skip to content
Bottle

Confirm several customers' cylinder balances

POST
/customers/holdings/confirm
curl --request POST \
  --url https://example.com/customers/holdings/confirm \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "customerIds": [ "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f" ] }'

Confirms that every cylinder each customer held before Bottle has been entered. A customer already confirmed, archived or missing is left as it is and listed as skipped.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
customerIds
required
Array<string>
>= 1 items <= 1000 items

Responses

Section titled “Responses”

200

Section titled “200”

Whose balance was confirmed, and who was skipped

Media typeapplication/json
object
done
required
Array<object>
object
customerId
required

UUID v7

string format: uuid
name
required
string
skipped
required
Array<object>
object
customerId
required

UUID v7

string format: uuid
name
required
string | null
reason
required
string
Allowed values: not_found archived unchanged

Example 

{
  "done": [
    {
      "customerId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
    }
  ],
  "skipped": [
    {
      "customerId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "reason": "not_found"
    }
  ]
}

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 of that tenant

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