Information
- OpenAPI version:
3.1.0
Overview
Bottle API 0.1.0
Section titled “Bottle API 0.1.0”Orders, routing and invoicing for gas and fuel distributors. This spec is the contract for the web app, the driver app and the WhatsApp agent.
Authentication
Register and sign in under /auth, which sets a session cookie. Every endpoint described here needs that session.
Tenants
A person can belong to several tenants with a different role in each. Tenant-scoped endpoints read X-Tenant-Id, and the header only works for a tenant the caller is a member of. GET /me lists them.
Permissions
Every tenant-scoped endpoint names the scope it needs, as resource:action. A session carries the scopes its role allows. An API key carries the scopes it was granted, which is never more than the person who created it could grant. A caller without the scope is refused with missing_scope, whichever way it arrived.
Plans
Some parts of Bottle start on a bigger plan: rounds, vehicles, the rota and drivers, cash in the cab, regular orders, and several yards. An endpoint in one of them carries x-plan-area, naming the area. When the business is on a plan without it, every way in is refused with 403 and { "error": "plan_locked", "area": "rounds", "message": "..." }, reading included. Nothing is deleted on a smaller plan, and the records come back when the business moves up. GET /billing lists what is open under features.
Operations
Section titled “Operations”GET
/healthPOST
/cash/handoversDELETE
/cash/handovers/{id}GET
/cashPOST
/cash/unsettleGET
/cash/mineGET
/cash/ledgerPOST
/cash/settlePOST
/me/devicesDELETE
/me/devices/{token}GET
/me/dataPOST
/me/eraseGET
/mePOST
/tenantsGET
/businessPATCH
/businessGET
/membersDELETE
/members/{userId}PATCH
/members/{userId}GET
/invitationsPOST
/invitationsDELETE
/invitations/{id}PATCH
/account-numbersGET
/customersPOST
/customersDELETE
/customers/{id}PATCH
/customers/{id}POST
/customers/bulkPATCH
/addresses/{id}GET
/api-keysPOST
/api-keysDELETE
/api-keys/{id}GET
/connectionsDELETE
/connections/{id}PATCH
/connections/{id}GET
/billingPOST
/billing/planPOST
/billing/portalPATCH
/help-chat/settingsPATCH
/business-settingsDELETE
/asset-references/{id}GET
/assetsPOST
/assetsPOST
/assets/identifyPOST
/assets/receiveGET
/assets/{id}DELETE
/work-report/checks/{id}GET
/importsPOST
/importsPOST
/imports/checkGET
/help/searchGET
/email-logGET
/rate-setsPOST
/rate-setsDELETE
/rate-sets/{id}PATCH
/rate-sets/{id}GET
/categoriesPOST
/categoriesDELETE
/categories/{id}PATCH
/categories/{id}POST
/product-detailsDELETE
/gas-types/{id}PATCH
/gas-types/{id}GET
/gas-typesPOST
/gas-typesGET
/productsPOST
/productsPATCH
/products/{id}POST
/products/bulkDELETE
/products/{id}/stockGET
/price-rulesPOST
/price-rulesDELETE
/price-rules/{id}GET
/ordersPOST
/ordersGET
/orders/idsGET
/orders/{id}DELETE
/orders/{id}PATCH
/orders/{id}POST
/orders/bulkPOST
/orders/exportGET
/deliveriesPOST
/standing-ordersDELETE
/standing-orders/{id}POST
/entry-draftsDELETE
/delivery-partners/{id}GET
/rounds/whyPOST
/rounds/whyPOST
/rounds/learnedDELETE
/rounds/learned/{id}PATCH
/rounds/learned/{id}GET
/patchesPOST
/patchesDELETE
/patches/{id}PATCH
/patches/{id}GET
/locationsPOST
/locationsPATCH
/locations/{id}GET
/vehiclesPOST
/vehiclesPATCH
/vehicles/{id}GET
/driversGET
/roundsPOST
/roundsGET
/rounds/{id}DELETE
/rounds/{id}PATCH
/rounds/{id}DELETE
/rounds/{id}/issuePOST
/rounds/plan-dayGET
/driver/dayGET
/planningPATCH
/planningGET
/overviewGET
/retentionPUT
/retentionGET
/erasuresGET
/closuresPATCH
/closure-settingsPOST
/closed-daysDELETE
/closed-days/{id}PATCH
/leave-policyPOST
/shift-patternsDELETE
/shift-patterns/{id}PATCH
/shift-patterns/{id}GET
/time-offPOST
/time-offDELETE
/time-off/{id}GET
/coverPOST
/coverDELETE
/cover/{id}GET
/rotaGET
/eventsGET
/presencePOST
/presenceDELETE
/presence/{tabId}POST
/presence/cursorGET
/searchGET
/xeroDELETE
/xeroPATCH
/xeroPOST
/xero/selectionDELETE
/xero/selectionPOST
/xero/connectPOST
/xero/syncGET
/setupPOST
/setup/activatePOST
/setup/dismissGET
/trackPUT
/track/leaveGET
/shopsPOST
/shopsDELETE
/shops/{id}PATCH
/shops/{id}POST
/shops/{id}/pullDELETE
/storefront/pages/{id}DELETE
/storefront/bin/{id}DELETE
/storefront/posts/{id}DELETE
/storefront/themes/{id}GET
/storefrontDELETE
/storefront/domains/{id}DELETE
/customer-email/domainGET
/stock/rentGET
/stockPOST
/stock/movementsPOST
/stock/transfersGET
/stock-takesPOST
/stock-takesPOST
/stock/suppliersPOST
/invoices/cancelPOST
/invoices/pdfsGET
/invoicesPOST
/invoices/runPATCH
/invoice-settingsGET
/taxPATCH
/taxGET
/whatsappDELETE
/whatsappPATCH
/whatsappAuthentication
Section titled “Authentication”sessionCookie
Section titled “sessionCookie”Set by signing in under /auth. Used by our own web and driver apps.
Security scheme type: apiKey
Cookie parameter name: __Host-bottle.session_token
apiKey
Section titled “apiKey”A key created by an owner or admin of the business, sent as Authorization: Bearer <key>. Carries only the scopes it was granted.
Security scheme type: http
assistantSession
Section titled “assistantSession”The token answered when a conversation with Rosie starts, sent as Authorization: Bearer <token>. Opens that one conversation and nothing else.
Security scheme type: http
tenantHeader
Section titled “tenantHeader”Which of your tenants the request is for. Rejected unless you are a member of it.
Security scheme type: apiKey
Header parameter name: X-Tenant-Id