• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
Update item modifier lists

POST /v2/catalog/update-item-modifier-lists

Updates the CatalogModifierList objects that apply to the targeted CatalogItem without having to perform an upsert on the entire item.


Permissions
ITEMS_WRITE
Try in API Explorer
Name Description
item_ids
string [ ]

Required

The IDs of the catalog items associated with the CatalogModifierList objects being updated.

modifier_lists_to_enable
string [ ]

The IDs of the CatalogModifierList objects to enable for the CatalogItem.

modifier_lists_to_disable
string [ ]

The IDs of the CatalogModifierList objects to disable for the CatalogItem.

Response Fields

Name Description
errors
Error [ ]

Information on any errors encountered.

updated_at
string

Examples

You are viewing an old version of the API
POST /v2/catalog/update-item-modifier-lists
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
curl https://connect.squareup.com/v2/catalog/update-item-modifier-lists \
  -X POST \
  -H 'Square-Version: 2020-09-23' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "item_ids": [
      "H42BRLUJ5KTZTTMPVSLFAACQ",
      "2JXOBJIHCWBQ4NZ3RIXQGJA6"
    ],
    "modifier_lists_to_enable": [
      "H42BRLUJ5KTZTTMPVSLFAACQ",
      "2JXOBJIHCWBQ4NZ3RIXQGJA6"
    ],
    "modifier_lists_to_disable": [
      "7WRC16CJZDVLSNDQ35PP6YAD"
    ]
  }'
Response JSON
{
  "updated_at": "2016-11-16T22:25:24.878Z"
}

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?