Skip to content
Bottle
Search
Ctrl
K
Cancel
Menu
Getting started
What Bottle is
Starting a business
Setting up
Tours
Working together
Finding things
Adding your people
Day to day
Your day
Customers
Products
Orders
Regular deliveries
Getting paid
Invoices
Rounds
Out on the round
The driver app
Rota
Tracking
Emails to customers
Cash
Stock
Cylinder hire
VAT
Privacy and retention
Connections
Connecting other software
Accounting (Xero)
Connecting your shop
Connecting an assistant
Your account
Signing in safely
Plans and billing
Accessibility and appearance
For developers
Overview
API keys
Permissions
Hosting
Connecting over MCP
Search
The driver apps
Routing, maps and geocoding
Notifications
Working together
API reference
Overview
System
Overview
Health check
Cash
Overview
List cash hand-overs
Say cash has been handed in
Agree a hand-over, or say it is wrong
Take back a hand-over
List cash owed by drivers
Put a count-in back
Get the signed-in driver's cash
List cash takings
Settle the cash a driver is carrying
Account
Overview
Register a phone for push notifications
Stop push notifications to a phone
List invitations waiting for you
Accept an invitation waiting for you
Turn down an invitation waiting for you
Export your account data
Close your account
Stop viewing as somebody
Accept the terms and the privacy notice
Get the signed-in user
Create a business
Get the business profile
Update the business profile
Members
Overview
List members
Remove a member
Change a member's role
Invitations
Overview
Get an invitation by token
Accept an invitation
List open invitations
Create an invitation
Resend an invitation
Cancel an invitation
Customers
Overview
List customers
Create a customer
Get a customer
Archive a customer
Update a customer
List possible duplicate customers
List possible duplicates of a customer
Dismiss a duplicate suggestion
Get delivery times
Set delivery times
List delivery addresses
Create a delivery address
Update a delivery address
Merge two customers
List the cylinders a customer is holding
API keys
Overview
List API keys
Create an API key
Revoke an API key
Connections
Overview
List connected apps
Disconnect an app
Change an app's permissions
Billing
Overview
Get the subscription
List Bottle invoices
Sync the subscription from Stripe
Start a checkout session
Change the plan
Open the billing portal
Console
Overview
List businesses
Get a business
Set when a business's trial ends
Set the plan a business is treated as being on
Set a business's allowances
Lock a business
Unlock a business
List people
Get a person
Lock an account
Unlock an account
List sign-up codes
Create a sign-up code
Remove a sign-up code
Ask a business to let Bottle support in
Open a business as one of its people
List what staff have done
The version of each document in force
Put a version of a document in force
List what the plans cost
Set what a plan costs
Discount a plan for everyone new
Take a plan's discount off new checkouts
Give one business a discount
Take a business's discount away
Agree a price for one business
Put a business back on its plan's price
Email log
List emails sent
One email, as it was sent
Products
Delete a gas type
Update a gas type
List gas types
Create a gas type
List the products ordered most
List products
Create a product
Get a product
Update a product
Upsert a product from a shop
List a customer's agreed rates
Set an agreed rate
Remove an agreed rate
Orders
Send a payment link
Mark an order paid or unpaid
Return the undelivered remainder
Settle a refund
List orders
Create an order
Order counts for the day
Get an order
Update an order
List delivery options
Create a delivery option
Update a delivery option
List standing orders
Create a standing order
Get a standing order
End a standing order
Update or pause a standing order
Payments
What is in the business's Stripe account
Get the payment account
Connect a payment account
Privacy
Get retention settings
Update retention settings
List customers due for erasure
Export a customer's data
Erase a customer
List erasures
Rounds
List delivery patches
Create a delivery patch
Delete a delivery patch
Update a delivery patch
List bases
Create a base
Update a base
Look up the nearest postcode
List vehicles
Create a vehicle
Update a vehicle
List driver profiles
Update a driver profile
Who is off on a day
Mark a driver off for a day, or back on
List rounds
Create a round
Get a round
Delete a planned round
Update a round
Issue a round to its driver
Retract a round from its driver
Update a round's status
Get live timing for a round
Say where the round's van is
Move a stop to another day
Create a payment link at the door
Record a stop outcome
Plan a whole day
Get ways to bring a round within its limits
Get a round's load
Confirm what was loaded
Put more stock on the van mid-round
Sell from the van
Find a customer from the van
A door asks for more
Take cash at a door
Price what a door is about to take
Re-optimise a round
Move an order between rounds
The caller's day, for the driver apps
Get planning settings
Update planning settings
Get today's overview
Who is planning a day
Suggest postcodes
List the addresses at a postcode
Rota
Days the business does not deliver
Change the bank holiday settings
Close for a day or more
Open again
Get the time off settings
Change the time off settings
List shift patterns
Design a shift pattern
Delete a shift pattern
Change a shift pattern
Set a driver's pattern and time off terms
List time off
Ask for or book time off
Approve or decline a request
Cancel time off
List cover
Put somebody on cover
Take somebody off cover
The rota between two dates
Notifications
List my notifications
Mark a notification read
Mark every notification read
What I want to hear about
Change what I want to hear about
Live
Hear what changes
Who is here
Say where you are
Say you have gone
Say where you are pointing
Search
Search the business
Accounting
Where the business stands with Xero
Disconnect Xero
Change the accounting settings
Start connecting Xero
Xero sending the browser back
The organisation's accounts
Run the sync now
Setup
Mark awards as celebrated
How far setup has got
Skip, unskip or answer a step
Finish setting up later
Tracking
Get delivery tracking
Set where to leave a delivery
Shops
List connected shops
Connect a shop
Disconnect a shop
Update a shop
Pull a shop's catalogue
Stock
The rent cylinders out are running at
Get stock levels
List stock movements
Move stock
Move stock, several lines at once
The stock report
List low-stock levels
Set a low-stock level
Invoices
Who owes most
What was invoiced, month by month
List invoices
Get an invoice
Download an invoice as a PDF
Mark an invoice paid, or not
Cancel an invoice
Raise the invoices that are due
Get invoice settings
Update invoice settings
Tax
Get VAT settings
Update VAT settings
Support
Get what Bottle support may do in this business
Set what Bottle support may do in this business
List requests from Bottle support
Approve or decline a request from Bottle support
Overview
API keys
Section titled “API keys”
Keys a business issues to integrations it trusts
Operations
Section titled “Operations”
GET
/api-keys
POST
/api-keys
DELETE
/api-keys/{id}