Sign in

v1

latestOpenAPI 3.0.12026-07-242871595.3 MB
ORDERS

Gets a list of orders

Displays a list of orders. See Manage orders data for more details.

get/v3/merchants/{mId}/orders

Path parameters

mIdstring required

Merchant identifier (mId).

Query parameters

filterstring

Filter fields to display search results: [employee.id, note, modifiedTime, orderType, touched, cardTransaction.last4, manualTransaction, employee.name, title, device.id, externalReferenceId, clientCreatedTime, total, payType, testMode, createdTime, id, state, deletedTime] Note: Search results for the list of orders list is restricted to the last 90 days if the filter fields include: [deletedTime, externalReferenceId, createdTime, total, payType, title, note, state, manualTransaction, cardTransaction.last4, testMode, touched]

expandstring

Additional information provided as an expanded response: [employee, payments, refunds, credits, voids, payment.tender, payment.cardTransaction, lineItems, customers, serviceCharge, discounts, orderType, lineItems.discounts, lineItems.modifications]

Headers

User-Agentstring required

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

Response

Successful response.

idstring

Unique identifier.

currencystring

Three-letter ISO 4217 currency code for the order amount.

totalinteger

Total price of the order. Format: Cents

externalReferenceIdstring

External reference identifier for the order, such as an invoice or purchase order (PO) number.

unpaidBalanceinteger

Total unpaid balance Including refunds, manual refunds, tax, tip, service charge, non-revenue items, paid gift card activations, loads, and discounts.

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

Payment status of the order.

titlestring

Order title.

notestring

Any additional information about the order to print on the order receipt or displayed in apps.

taxRemovedboolean

Indicates if applicable tax is removed from the order. Values: True - Tax is applicable on an order. False - Default; tax is removed from the order.

isVatboolean

Indicates whether value-added tax applicable on the order. Values: True False

statestring

State of the order. If no value is set, the state defaults to null, which indicates a hidden order. A hidden order is not displayed in user interfaces and is retrieved using its identifier (Id). When an order is created using: REST API the value must be manually set to open. Android SDK the value must be left empty and is updated to open and locked automatically when actions such as taking payments and adding line items occur. The state value is not checked or enforced by the Clover server; at this time it is used for visualization purposes only.

manualTransactionboolean

Indicates whether the order is a manual transaction, that is a transaction with an arbitrary amount defined and not associated with any inventory items. Example: The Clover Sale App and Clover Manual Transaction App create manual transactions. A manual transaction has a single associated line item to hold the sale amount, but the generated receipt displays this differently to indicate that it is not considered a typical order with inventory items. Values: True False

groupLineItemsboolean

Indicates whether similar line items should be grouped together on the receipt generated for the order. Item similarity is based on items with matching values for a set of properties including price, modifiers, and discounts.

testModeboolean

Indicates whether the 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. These 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'

Choice to pay the amount. Values: SPLIT_GUEST SPLIT_ITEM SPLIT_CUSTOM FULL

createdTimeinteger

Time when order was created.

clientCreatedTimeinteger

Time when order was created on the client server.

modifiedTimeinteger

Time when order was modified.

deletedTimestampinteger

Time when order was deleted.