v1

latestOpenAPI 3.0.12026-07-242871595.3 MB

INVENTORY

Get all modifiers

Retrieves all modifiers from all modifier groups.

get/v3/merchants/{mId}/modifiers

mIdstring required

Merchant identifier.

filterstring

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

expandstring

Expandable fields to display additional nested information: [modifierGroup]

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

User-Agentstring required

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

Successful response. Displays all modifiers.

idstring

Unique identifier of the modifier.

namestring

Modifier name.

alternateNamestring

Modifier alternate name.

availableboolean

Indicates whether the modifier is available across all channels.

priceinteger

Additional cost associated with using the modifier.