You are viewing an old version of the API
Apply modifier list
V1

Deprecated

Note We recommend using the Square API (V2) for all new development when possible.

Associates a modifier list with an item so the associated modifier options can be applied to the item



Required permissions ITEMS_WRITE

Path Parameters

Name Description
location_id
string

Required

The ID of the item's associated location.

modifier_list_id
string

Required

The ID of the modifier list to apply.

item_id
string

Required

The ID of the item to add the modifier list to.

Response Fields

Name Description
id
string

The item's ID. Must be unique among all entity IDs ever provided on behalf of the merchant. You can never reuse an ID. This value can include alphanumeric characters, dashes (-), and underscores (_).

abbreviation
string

The text of the item's display label in Square Point of Sale. Only up to the first five characters of the string are used.

available_for_pickup
boolean

If true, the item can be added to pickup orders from the merchant's online store. Default value: false

available_online
boolean

If true, the item can be added to shipping orders from the merchant's online store.

category
V1​Category

The category the item belongs to, if any.

category_id
string

The ID of the item's category, if any.

color
string

The color of the discount's display label in Square Point of Sale, if not the default color. The default color is 9da2a6.

description
string

The item's description.

fees
V1​Fee [ ]

The fees that apply to the item, if any.

master_image
V1​Item​Image

The item's master image, if any.

modifier_lists
V1​Modifier​List [ ]

The modifier lists that apply to the item, if any.

name
string

The item's name.

taxable
boolean

Deprecated. This field is not used.

type
string

The item's type. This value is NORMAL for almost all items.

v2_id
string

The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.

variations
V1​Variation [ ]

The item's variations. You must specify at least one variation.

visibility
string

Indicates whether the item is viewable from the merchant's online store (PUBLIC) or PRIVATE.

Examples

You are viewing an old version of the API
PUT /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id}
cURL
  • cURL
curl https://connect.squareup.com/v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} \
  -X PUT \
  -H 'Authorization: Bearer ACCESS_TOKEN'

Share Feedback

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