Sign in

v1

latestOpenAPI 3.0.12026-07-242871595.3 MB
INVENTORY

Get all modifiers in a single modifier group

Retrieves a list of modifiers in a single modifier group.

get/v3/merchants/{mId}/modifier_groups/{modGroupId}/modifiers

Path parameters

mIdstring required

Merchant identifier.

modGroupIdstring required

Modifier group identifier.

Query parameters

filterstring

Filter fields to display search results: [modifiedTime, price, name, alternateName, id, modifierGroup.id]

expandstring

Expandable fields to display additional nested information: [modifiers, items]

offsetinteger

Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.

limitinteger

Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000

Headers

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>

Response

Successful response. Displays all modifiers in a single modifier group.

idstring

Modifier group identifier.

namestring

Name of the modifier group.

alternateNamestring

Alternate name of the modifier.

availableboolean

Indicates whether the modifier group is available for sale across all channels, including point of sale (POS) devices, customer-facing kiosks, and online ordering websites.

priceinteger

Price of the modifier group. Use price type and merchant currency to determine the actual item price. For non-VAT merchants who do not pay value-added tax, this field is exclusive of tax. For VAT merchants, this field is inclusive of tax. Format: Cents