Sign in

v1

latestOpenAPI 3.0.12026-07-242871595.3 MB
ORDERS

Create custom orders

Creates or updates orders with a non-Clover inventory and dynamically calculates taxes. Valid fields are: taxRemoved, note, title, state, testMode, manualTransaction, groupLineItems, and orderType. Use separate API calls to add line items. See the tutorial Create custom orders. To create orders with Clover inventory and leverage real-time totals and tax calculation features, use the Create an atomic order endpoint and see the tutorial to Manage orders data.

post/v3/merchants/{mId}/orders

Path parameters

mIdstring required

Merchant identifier.

Headers

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>

Request body

idstring

Unique identifier of the order.

currencystring

Three-letter ISO 4217 currency code. Format: Lower case Length: Max 3

totalinteger

Total price of the order in cents.

externalReferenceIdstring

External reference identifier, if associated with the order.

unpaidBalanceinteger

Net of orders with payment minus the amount collected. Includes refunds, manual refunds, tax, tip, service charge, non-revenue items, paid gift card activations and loads, and discounts.

paymentState'OPEN' | 'PAID' | 'REFUNDED' | 'CREDITED' | 'PARTIALLY_PAID' | 'PARTIALLY_REFUNDED'

Indicates the state of the payment, whether paid, open, partially paid, and so on.

titlestring

Title associated with the employee.

notestring

Information about the order that may be printed on the order receipt and displayed in apps.

taxRemovedboolean

Indicates whether tax is removed and is not applicable to the order.

isVatboolean

Indicates whether the order was created by a merchant that charges for value-added tax (VAT).

statestring

Order state. Values: . open or OPEN and locked - Automatically set by Clover, for example: when a line item is added to the order or a payment is taken. . When an order is created using REST API, Clover recommends manually setting the order state value to Open. . When an order is created using Android SDK, do not manually set the order state. The value must be left empty, and Clover automatically updates the value to open and locked. . Null - Default value when no value is manually set. This indicates a hidden order. Hidden orders do not display on the screen but can be retrieved using order ID.

manualTransactionboolean

Indicates a manual transaction for the order. In a manual transaction: An arbitrary amount is defined and not associated with any inventory items. For example, the Clover Sale app and Clover Manual Transaction app create manual transactions. A single line item is associated to hold the sale amount, but the generated receipt displays this differently to indicate the order is not a typical order with inventory items.

groupLineItemsboolean

Indicates whether similar line items are grouped together on the order receipt based on matching values for properties, such as price, modifiers, and discounts.

testModeboolean

Indicates whether this order was created in test mode. Payments made against test orders are not processed. You can delete test mode orders from the Orders App on the merchant's device or web dashboard. Test mode orders are also deleted when the device sends a POST to the /v2/merchant/{mId}/orders/delete_all_tests endpoint.

payType'SPLIT_GUEST' | 'SPLIT_ITEM' | 'SPLIT_CUSTOM' | 'FULL'

During the payment flow: If the user chooses to split the payment for the order, this field is set to one of the Split values to indicate how to split the full amount. If the user chooses to pay for the order in full with one payment, then this field value is Full.

createdTimeinteger

Time when the order was created on the server.

clientCreatedTimeinteger

Time when the client created the order.

modifiedTimeinteger

Last modified time of the order.

deletedTimestampinteger

Time when the order was deleted.