Introduction

The Cloudbeds POS API runs point of sale for a property's outlets: its
restaurants, bars, cafés, spas and shops. It is the API behind the Cloudbeds POS
app and the POS settings in Cloudbeds PMS, and it covers everything those use:

• Setting up an outlet: its profile, the catalog items it sells, its menus,
  its floor plan of sections and tables, its printers and receipt branding.
• Running service: taking orders, firing them to the kitchen, pricing,
  discounting, tipping, transferring orders between servers, and splitting
  checks.
• Getting paid: full or partial payments, refunds, payments taken on
  other Cloudbeds payment surfaces, and charging orders to a guest's room.
• Managing the team: staff, PINs, roles and permissions.
• Reporting: daily sales and per-server performance.

Paid orders are recorded in Cloudbeds as POS checks on a folio, with their
items, taxes, discounts and gratuity, so POS revenue appears in the property's
accounting and on the guest's bill.

How the API is organised

Conventions

• Base URL: https://api.cloudbeds.com. Every path starts with /pos/.
• Property: every request names the property in the x-property-id header.
• Money: decimal strings or numbers in the property's currency, with up to
  three decimal places for currencies that use them. The server computes all
  totals, taxes and fees. Treat the amounts it returns as authoritative.
• Identifiers: UUIDs, except catalog items and reservations, which use their
  Cloudbeds ids.
• Partial updates: PATCH and most PUT operations change only the fields
  you send. Where an explicit null clears a field, the operation says so.
• Errors: {"detail": ...} with a conventional HTTP status. See
  Errors.

Where to start

1. Authentication: get an access token, then sign a staff
   member in.
2. Taking orders: the order lifecycle, step by step.
3. Payments and folios: how an order gets paid and
   where it lands in Cloudbeds.