Modifiers and modifier groups are used to customize items, particularly in restaurants. Modifiers are specific options added to an item, such as tofu, avocado, or extra dressing for a salad.

Manage modifiers on the Merchant Dashboard

Merchants can manage modifier groups and modifiers on the Clover Merchant Dashboard. See Clover Help to Manually manage item and modifier availability.

View modifier availability with Clover REST APIs

Prerequisite

Generate a merchant-specific test API token in sandbox.

Steps

You can view the item modifier stock for a merchant.

1. Send a GET request to /v3/merchants/{mId}/modifier_groups/{modGroupId}/modifiers/{modId}.
2. Enter required information—mId, modGroupId and modId.
3. Set the Authorization header as Bearer token type, and enter the merchant's API token.

In the response, check the value of the available parameter:

• True—Indicates that the modifier stock is available.
• False—Indicates that the modifier stock is not available.

Request and Response example—View modifier stock availability

curl --request GET \
     --url 'https://apisandbox.dev.clover.com/v3/merchants/{mId}/modifier_groups/{modGroupId}/modifiers/{modId}' \
     --header 'content-type: application/json' \
     --header 'authorization: Bearer {access_token}' \   

{
   "id": "0ZHZ8Y66S63EP",
   "name": "Waffle cone",
   "available": true,
   "price": 100,
   "modifiedTime": 1738627443000,
   "modifierGroup": {
       "id": "3Z29BX6C013XC"
   },
   "deleted": false
}

Related topics

• Work with inventory
• Get a modifier endpoint
• Manage modifier groups and modifiers tutorial
• Clover Help—Define your items