Skip to main content
POST
Ring up an in-person sale
Creates the same record the dashboard’s POS produces: source pos, status paid, stock reduced for tracked items, and a completed payment attached. An app that already holds WRITE_ORDERS may use POST /orders/pos instead.

Authorizations

Authorization
string
header
required

Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side, so never send a shop id.

Body

application/json
items
object[]
required

Line items (at least one). Each id must resolve to a product, food or service in this store.

Minimum array length: 1
discount
number
default:0
Required range: x >= 0
tax
number
default:0
Required range: x >= 0
paymentMethod
enum<string>
default:cash
Available options:
cash,
card,
transfer,
other
customerName
string
customerEmail
string<email>
customerPhone
string
additionalInfo
object[]
Maximum array length: 50

Response

The created sale.

Standard Salesive response envelope. The operation-specific payload is carried in data.

status
integer
required

HTTP status code, echoed in the body.

success
boolean
required

Whether the request succeeded.

message
string
required

Human-readable result message.

data
object

An in-person sale. It is the same order record the dashboard's POS creates: source pos, status paid, stock reduced and a completed payment attached.