post

/register_sales

Create or update a register sale. Returns a single new or updated sale object. See Sales Tutorials for usage information.

Note: Promotions cannot be used with this endpoint.

Authorization

apiKey - Authorization

Request Body

New or updated register sale object.

Schema

object

Editable attributes of the sale

source

string

This is the identifier of the 3rd party system that the source_id is associated with. ‘Xero’ or ‘Magento’ would be examples.

source_id

string

The ID of the sale on the client side or another system where the sale was originally created.

register_id

string

The ID of the register where the sale was created.

1 validation

customer_id

string

The ID of the customer associated with this sale.

1 validation

user_id

string

The ID of the user (cashier) who created the sale.

1 validation + required

sale_date

string

The date of the sale in RFC3339 format. If not provided will be added as the time the sale reached the server.

1 validation

note

string

A note on the sale entered by the cashier.

status

string

Status of the sale.

1 validation + required

short_code

string

Short, unique code to be printed on the receipt for loyalty tracking purposes.

invoice_number

string

The invoice number for the sale. If left null it will be populated by Vend with the next available invoice number.

accounts_transaction_id

string

Xero invoice reference ID. Only editable for ONACCOUNT sales.

register_sale_products

array[object]

Line items.

register_sale_payments

array[object]

Payments.

Responses

Schema

object

A response containing a single sale object

register_sale

object

required

Send a Test Request

Send requests directly from the browser (CORS must be enabled)

Path Params

1 path param not set

domain_prefix

$$.env

1 variable not set

Authorization