API Reference

Email a receipt

post
https://api.smoothpos.net/sale/email-receipt.json

Emails a sale's receipt.

Required permission:

GroupPermission
SalesCreate, edit and delete sales; manage = create sales and change their staff member or customer (includes view)
Body Params
string
integer

ID of the customer the sale is attached to. Leave it out for a walk-in sale.

integer

ID of the employee who processed the sale.

fulfillments
array of objects

Shipping or pickup fulfillments for the sale.

fulfillments
boolean

Set to true to print a gift receipt.

lines
array of objects

The items sold.

lines
date-time

When the sale happened (ISO 8601). Reads back as 0001-01-01T00:00:00Z when it isn't set.

metadata
object

Your own data, stored with the sale. Each value is an object like {"type": "string", "value": "…"}.

payments
array of objects

Payments taken for the sale.

payments
string
required

Your receipt or order number. You can search by it with GET /sales.json?receipt_number=….

integer
required

Number identifying the register within the store, such as 101. Send a number: a string like "101" is rejected.

number
required

Shipping amount charged. Send 0 if there's no shipping.

number
required

Tax included in shipping. Send 0 if none.

integer

ID of the store the sale belongs to. Get IDs from GET /stores.json.

tags
array of strings

Free-text tags.

tags
number
required

Total discount across all lines.

number
required

Total value paid with loyalty.

integer
required

Loyalty points earned on the sale.

number

Amount paid so far.

number
required

Sale total.

integer
required

Total number of units across all lines.

number
required

Total tax across all lines and shipping.

Responses

Updated 8 days ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 days ago

Did this page help you?