Clover Category resource. Schema derived from the Clover Platform REST API v3 reference.
Type: objectProperties: 8
RestaurantPoint-of-SalePaymentsRetailSMBHardware
Category is a JSON Structure definition published by Clover, describing 8 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/clover/refs/heads/main/json-structure/platform-rest-api-category-structure.json",
"name": "Category",
"description": "Clover Category resource. Schema derived from the Clover Platform REST API v3 reference.",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier",
"example": "9ABCDEF1234567"
},
"name": {
"type": "string",
"description": "The name of the category which will appear in Clover Register App.",
"example": "Example name"
},
"sortOrder": {
"type": "int32",
"description": "Integer used to determine how this category is sorted against other categories.",
"example": 1
},
"items": {
"type": "array",
"items": {
"type": "object"
},
"example": []
},
"colorCode": {
"type": "string",
"description": "Hex code representation of the color assigned to this category and its items, in the form of #fff, #ffffff, or #ffffffff",
"example": "ABC123"
},
"deleted": {
"type": "boolean",
"description": "Whether the category has been deleted.",
"example": true
},
"modifiedTime": {
"type": "int32",
"description": "The time this category was last modified",
"example": 1718153645000
},
"canonical": {
"type": "object",
"example": {}
}
}
}
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.