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.

Clover merchants can mark item modifiers as unavailable or out-of-stock on the Clover Merchant Dashboard and their point-of-sale (POS) devices. When the modifier is back in stock, merchants can easily update its availability.

This feature enhances operational efficiency by improving item stock and order management. Item modifier availability in the inventory is handled both through the Clover Merchant Dashboard and the Clover REST APIs.

Manage modifier availability 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.

Manage modifier availability with Clover REST APIs

Prerequisite

Generate a merchant-specific test API token in sandbox.

View modifier availability

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
}

Update modifier availability

1. Send a POST 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.
4. Set the available parameter value as follows:

• True (default)—Indicates the modifier stock is available.
• False—Indicates the modifier stock is not available.

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

Request and response sample—Update modifier availability

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

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

Related topics

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