Gets a list of orders

get

https://apisandbox.dev.clover.com/v3/merchants/{mId}/orders

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

Path Params

mId

string

required

Merchant identifier (mId).

Query Params

filter

string

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]

expand

string

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]

Response

200Successful response.