Clover · Example Payload

Platform Rest Api Order Example

RestaurantPoint-of-SalePaymentsRetailSMBHardware

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": {}
}

Work with this as data

Every example here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for examples

4 MCP tools reach this
  • find_examplesBrowse and filter every example in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This example 
curl "https://apis.io/api/v1/examples/platform-rest-api-order-example"
All examples 
curl "https://apis.io/api/v1/examples?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.