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

You are viewing an old version of the API
Create modifier list
V1
Square V1 APIs

We recommend using the Square API (V2) for all new development when possible. See When to use Connect V1 to learn more about working with V1 endpoints.

Deprecated
Effective November 20th, 2019

Creates an item modifier list and at least 1 modifier option for it.

Required permissions: ITEMS_WRITE

Deprecation date

2019-11-20

Retirement date

2020-11-18

Replaced by

UpsertCatalogObject
Migration guide

Path Parameters

Name Description
location_id
string

Required

The ID of the location to create a modifier list for.

Request Body

Name Description
id
string

The modifier list's unique ID.

name
string

The modifier list's name.

selection_type
string

Indicates whether MULTIPLE options or a SINGLE option from the modifier list can be applied to a single item.

modifier_options
ModifierOption [ ]

The options included in the modifier list.

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.

Response Fields

Name Description
id
string

The modifier list's unique ID.

name
string

The modifier list's name.

selection_type
string

Indicates whether MULTIPLE options or a SINGLE option from the modifier list can be applied to a single item.

modifier_options
ModifierOption [ ]

The options included in the modifier list.

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.

Examples

You are viewing an old version of the API
POST /v1/{location_id}/modifier-lists
cURL
  • cURL
curl https://connect.squareup.com/v1/location_id0/modifier-lists \
  -X POST \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{}'

Share Feedback

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