Clover · Example Payload

Platform Rest Api Order Example

RestaurantPOSPaymentsRetailSMBHardware

Platform Rest Api Order Example is an example object payload from Clover, with 36 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

idcurrencycustomersemployeetotalexternalReferenceIdunpaidBalancepaymentStatetitlenoteorderTypetaxRemovedisVatstatemanualTransactiongroupLineItemstestModepayTypecreatedTimeclientCreatedTimemodifiedTimedeletedTimestampserviceChargeadditionalChargesdiscountslineItemspaymentsrefundscreditsvoidspreAuthsdeviceauthorizationsmerchantprintGroupsorderFulfillmentEvent

Example Payload

Raw ↑ 
{
  "id": "9ABCDEF1234567",
  "currency": "USD",
  "customers": [],
  "employee": {},
  "total": 1099,
  "externalReferenceId": "9ABCDEF1234567",
  "unpaidBalance": 1099,
  "paymentState": "OPEN",
  "title": "example-title",
  "note": "Example note value.",
  "orderType": {},
  "taxRemoved": true,
  "isVat": true,
  "state": "open",
  "manualTransaction": true,
  "groupLineItems": true,
  "testMode": true,
  "payType": "SPLIT_GUEST",
  "createdTime": 1718153645000,
  "clientCreatedTime": 1718153645000,
  "modifiedTime": 1718153645000,
  "deletedTimestamp": 1718153645000,
  "serviceCharge": {},
  "additionalCharges": [],
  "discounts": [],
  "lineItems": [],
  "payments": [],
  "refunds": [],
  "credits": [],
  "voids": [],
  "preAuths": [],
  "device": {},
  "authorizations": [],
  "merchant": {},
  "printGroups": [],
  "orderFulfillmentEvent": {}
}