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.

Prerequisite

Set up a sandbox account.

Set modifier stock availability

1. Log in to the Developer Dashboard.
2. From the Developer Account drop-down list, select a merchant name under Businesses. The test Merchant Dashboard appears.
3. From the left navigation menu, click Items. The Items page displays items in the inventory.
4. From the left navigation menu, click Modifier groups. The Modifier Groups page appears.
5. Click a modifier group. The page displays the modifiers and items assigned to the modifier group you selected.
6. To update a modifier availability, do one of the following:
   • Turn off the In stock toggle icon to indicate the modifier is not available. This modifier displays as not available on the Register and Dining apps.
   • Turn on the In stock toggle icon to indicate the modifier is available.

Bulk edit modifier stock availability

1. Log in to the Developer Dashboard.
2. From the Developer Account drop-down list, select a merchant name under Businesses. The test Merchant Dashboard appears.
3. From the left navigation menu, click Items. The Items page displays items in the inventory.
4. From the left navigation menu, click Modifier groups. The Modifier Groups page appears.
5. Click a modifier group. The page displays the modifiers and items assigned to the modifier group you selected.
6. To bulk update modifiers, select the checkboxes for multiple modifiers.
7. Click Bulk Edit. The Bulk Edit side panel appears.
8. Turn off or on the Modifier availability toggle icon to indicate whether the modifier is available for sale.
9. Turn off or on the Show or hide selected modifiers toggle icon to indicate whether you want to display them at the point of sale.
10. Click Save.

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 test 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—Get 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 test 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