Complete Order
Complete an order.
Authorizations
The 'Bearer' token can be obtained from the token management interface or via the login endpoint using your admin user credentials.
Query Parameters
A list of attributes that you wish to be returned in the payload. When empty or omitted, all fields will be included by default. Use dot-notation for both top-level resources and child resources, i.e. orders.id,orderItems.saleItemId,venues.name. Can be used in conjunction with except providing both parameters don't reference the same resource.
A list of attributes that you wish to exclude from the payload. When empty or omitted, all fields will be included by default. Use dot-notation for both top-level resources and child resources, i.e. orders.id,orderItems.saleItemId,venues.name. Can be used in conjunction with only providing both parameters don't reference the same resource.
Body
Request body for completing an order
The basket ID for which we want to complete an order. Basket IDs and Order IDs can be used interchangeably.
The payment method for the order. This will determine the transaction type for reporting purposes. This value will override the value stored against the supplied transactionId (if provided).
card-not-present-offline, card-not-present-online, card-present-offline, card-present-online, cash, complimentary, bank, ewallet-online, cheque, gift-card, money-order, split Breakdown of payments when using the 'split' payment method. The sum of all splits must equal the order total.
A payment plan object. This is currently only applicable for the processing of deposit payments. If a transanctionId is supplied, this must be omitted.
{ "type": "deposit" }If a customer can be found using this then customerName and customerEmail will be ignored.
Optional customer name, but required when the customer email doesn't already exist in the system.
Optional customer email. If this is present, fetch this user from the database and assign the order to this user.
This will be used in combination with customerName + customerEmail OR customerId. Single sign-on identifier for the customer, optional & only applicable to companies using a custom SSO solution.
Optional transaction ID. If supplied and valid, the transaction will be updated to a success status - otherwise a new transaction will be setup (providing the total is greater than 0).
Pass true if you want to prevent sending the order confirmation email, otherwise pass false or omit this property completely.
You should provide the payment media ID that is responsible for this transaction (for accurate epos and wallet balance reporting).