Skip to content
Bottle

List the cylinders held

GET
/storefront/sites/{host}/account/holdings
curl --request GET \
  --url 'https://example.com/storefront/sites/northgate.shop.getbottle.app/account/holdings?customerId=019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f'

Deliberately without a staff session: a shopper on the business’s own shop. Cylinders each customer of the account holds, by delivery address (from the order each went out on; ones not tied to an order are under a null address), with totals by product. Totals are the customer’s whole holding; a cylinder that came back at a different address than it went to can leave the by-address figures a little apart from the totals.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
host
required
string
Example
northgate.shop.getbottle.app

Query Parameters

Section titled “Query Parameters”
customerId

UUID v7

string format: uuid
Example
019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

Responses

Section titled “Responses”

200

Section titled “200”

Cylinders

Media typeapplication/json
object
totals
required
Array<object>
object
productId
required

UUID v7

string format: uuid
name
required
string
gasType
required
object
name
required
string
colour
required
string
quantity
required
integer
byAddress
required
Array<object>
object
address
required
object
id
required

UUID v7

string format: uuid
label
required
string
postcode
required
string | null
customerId
required

UUID v7

string format: uuid
customerName
required
string
lines
required
Array<object>
object
productId
required

UUID v7

string format: uuid
name
required
string
gasType
required
object
name
required
string
colour
required
string
quantity
required
integer
since
required
string | null format: date-time
Example
{
  "totals": [
    {
      "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
    }
  ],
  "byAddress": [
    {
      "address": {
        "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
      },
      "customerId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "lines": [
        {
          "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
        }
      ]
    }
  ]
}

400

Section titled “400”

Refused: the message says why

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer 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 from the shop itself, or the email is not confirmed yet

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

404

Section titled “404”

Not a shop. No body.

409

Section titled “409”

A real shop not selling now (shop_closed)

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

429

Section titled “429”

Too many tries

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}