Create Minimal Sale

Creates a fully settled sale with minimal input — the server looks up prices, taxes and auto-applied fees, assigns the next invoice number on the location's cloud register, and records a single payment for the bill total. Requires the p/c-bill permission on the location. This is the simplest way for an app to record a sale. Note: lines[].unit is required in practice (omitting it errors) even though it is declared nullable — pass the variant's unit, e.g. "pcs".

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required
integer | null
number | null

Bill-level discount amount.

string | null

Bill subtype (name or key of an existing bill subtype).

lines
array of objects
required

Items to sell. Each line: variant_id (required), unit (required in practice, e.g. "pcs"), unit_quantity (required, integer), discount_amount (optional). Prices and taxes are calculated server-side.

lines*
string
required

Payment method for the full amount: cash, card, bank-transfer, credit, gift-card, loyalty, or a custom company payment type.

string | null

Stored on the payment as extra.ref.

string
length ≤ 2048
Headers
string
required

The merchant install this request acts on (install.store_id from the app.installed webhook).

Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json