Skip to content
Bottle

Download a customer's price sheet

GET
/customers/{customerId}/prices.pdf
curl --request GET \
  --url 'https://example.com/customers/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/prices.pdf?prices=all' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token>

Every product the business sells to this customer (not archived, and not one kept for the other kind of customer) at what they pay today: their agreed rate, else their price list, else the trade price for a trade customer, else the list price, with any quantity prices, and the cylinder deposits they pay. Before VAT and with VAT when the business is registered. In the business’s own name, address and logo: the same document the Send rates email attaches. A plain link may carry tenantId in the query. Downloaded as a file, or opened in the browser with view=true.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
customerId
required

UUID v7

string format: uuid

Example 

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

UUID v7

Query Parameters

Section titled “Query Parameters”
view

Open it in the browser (inline) rather than download it.

string

Open it in the browser (inline) rather than download it.

prices

Which products to list: everything sold to them (all, the default), or only those whose price was agreed with them.

string
Allowed values: all agreed

Which products to list: everything sold to them (all, the default), or only those whose price was agreed with them.

Responses

Section titled “Responses”

200

Section titled “200”

The price sheet

Media typeapplication/pdf
string

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”

Not found

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