Skip to content
Bottle

List the cylinder problems a customer reported

GET
/customers/{id}/cylinder-reports
curl --request GET \
  --url https://example.com/customers/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/cylinder-reports \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token>

What the customer reported from their account on the shop, newest first: waiting, written off, invoiced, dismissed or withdrawn, with who reported, who acted and how many of that cylinder they hold now. A report changes nothing until the business acts on it.

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-3a2b1c0d9e8f

UUID v7

Responses

Section titled “Responses”

200

Section titled “200”

Reports

Media typeapplication/json
object
items
required
Array<object>
object
id
required

UUID v7

string format: uuid
customerId
required

UUID v7

string format: uuid
customerName
required
string
productId
required

UUID v7

string format: uuid
productName
required
string
gasType
required
object
name
required
string
colour
required
string | null
quantity
required
integer
> 0
problem
required

What the customer said happened: lost, stolen, damaged, or moved to another supplier.

string
Allowed values: lost stolen damaged moved_supplier
status
required

Pending: waiting for the business. written_off: the holding ended, with no charge. invoiced: the holding ended and the customer was invoiced. dismissed: closed with nothing changed. withdrawn: the customer took it back first.

string
Allowed values: pending written_off invoiced dismissed withdrawn
note
required
string | null
reportedAt
required
string format: date-time
reportedBy
required
string | null
withdrawnAt
required
string | null format: date-time
decidedAt
required
string | null format: date-time
decidedBy
required
string | null
businessNote
required
string | null
invoice
required
object
id
required

UUID v7

string format: uuid
number
required
string
pence
required
integer
description
required
string
heldNow
required
integer

Example 

{
  "items": [
    {
      "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "customerId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "problem": "lost",
      "status": "pending",
      "invoice": {
        "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
      }
    }
  ]
}

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, or without the permission this needs

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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

404

Section titled “404”

No such customer or report

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