Clover · Example Payload

Platform Rest Api Item Example

RestaurantPOSPaymentsRetailSMBHardware

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

Top-level fields

idhiddenavailableautoManageitemGroupoptionsnamealternateNamecodeskupricepriceTypedefaultTaxRatesunitNamecostisRevenuestockCounttaxRatesmodifierGroupscategoriestagscanonicalitemStockMenuItemmodifiedTimedeletedTimepriceWithoutVatcolorCode

Example Payload

Raw ↑ 
{
  "id": "9ABCDEF1234567",
  "hidden": true,
  "available": true,
  "autoManage": true,
  "itemGroup": {},
  "options": [],
  "name": "Example name",
  "alternateName": "Example alternateName",
  "code": "ABC123",
  "sku": "SKU-001",
  "price": 1099,
  "priceType": "FIXED",
  "defaultTaxRates": true,
  "unitName": "Example unitName",
  "cost": 1099,
  "isRevenue": true,
  "stockCount": 1,
  "taxRates": [],
  "modifierGroups": [],
  "categories": [],
  "tags": [],
  "canonical": {},
  "itemStock": {},
  "MenuItem": {},
  "modifiedTime": 1718153645000,
  "deletedTime": 1718153645000,
  "priceWithoutVat": 1099,
  "colorCode": "ABC123"
}