Square icon

Square

Consume Square API

Catalog → Update Item Modifier Lists

AI-generated

Overview

This node operation updates the modifier lists associated with specific catalog items in the Square API. It allows enabling or disabling certain modifier lists for one or more catalog items by specifying their IDs. This is useful for managing item customization options dynamically, such as adding or removing available modifiers for menu items in a restaurant or product options in a retail catalog.

Use Case Examples

  1. Enable specific modifier lists for multiple items by providing their item IDs and the modifier list IDs to enable.
  2. Disable certain modifier lists for selected items by specifying the item IDs and the modifier list IDs to disable.

Properties

Name Meaning
Item IDs Comma-separated list of catalog item IDs to update. Specifies which catalog items will have their modifier lists updated.
Modifier Lists to Enable Comma-separated list of modifier list IDs to enable for the specified items. These modifier lists will be added to the items.
Modifier Lists to Disable Comma-separated list of modifier list IDs to disable for the specified items. These modifier lists will be removed from the items.

Output

JSON

  • item_ids - Array of catalog item IDs that were updated.
  • modifier_lists_to_enable - Array of modifier list IDs that were enabled for the items.
  • modifier_lists_to_disable - Array of modifier list IDs that were disabled for the items.

Dependencies

  • Square API with appropriate API key credentials

Troubleshooting

  • Ensure that the item IDs and modifier list IDs are correctly formatted as comma-separated strings without extra spaces.
  • If the API request fails, check that the API credentials are valid and have the necessary permissions to update catalog items.
  • Errors related to invalid JSON or malformed input can occur if the input strings are not properly formatted.

Discussion