You are viewing an old version of the API
Create modifier option
V1

Deprecated

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

Creates an item modifier option and adds it to a modifier list



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 edit.

Request Body

Name Description
id
string

The modifier option's unique ID.

modifier_list_id
string

The ID of the modifier list the option belongs to.

name
string

The modifier option's name.

on_by_default
boolean

If true, the modifier option is the default option in a modifier list for which selection_type is SINGLE.

ordinal
integer

Indicates the modifier option's list position when displayed in Square Point of Sale and the merchant dashboard. If more than one modifier option in the same modifier list has the same ordinal value, those options are displayed in alphabetical order.

price_money
V1​Money

The modifier option's price.

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 option's unique ID.

modifier_list_id
string

The ID of the modifier list the option belongs to.

name
string

The modifier option's name.

on_by_default
boolean

If true, the modifier option is the default option in a modifier list for which selection_type is SINGLE.

ordinal
integer

Indicates the modifier option's list position when displayed in Square Point of Sale and the merchant dashboard. If more than one modifier option in the same modifier list has the same ordinal value, those options are displayed in alphabetical order.

price_money
V1​Money

The modifier option's price.

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/{modifier_list_id}/modifier-options
cURL
  • cURL
curl https://connect.squareup.com/v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options \
  -X POST \
  -H 'Authorization: Bearer ACCESS_TOKEN'

Share Feedback

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