Selection

externalId
required
string

The partner provided external identifier for the cart item.

isComplete
boolean
Default: true

Indicates if the menu item's required modifiers have been specified. If false, the cart is incomplete and cannot be submitted.

itemGroupGuid
required
string <uuid>

The GUID of item's menu group.

itemGuid
required
string <uuid>

The GUID of the menu item.

Array of objects (ModifierSelection)

Modifiers applied to the item.

openItemName
string or null

Name for an open item.

openPriceAmount
number or null <double>

Price for an open item. Required when openItemName is set.

Array of objects (PortionModifierSelections)

Modifiers applied to configured item portions (e.g. pizza halves).

quantity
number <double> > 0
Default: 1

Total item quantity.

specialRequest
string or null

Free-text instruction for this item (e.g. "cut in half"). Returned in the priced response as an entry under modifiers with a null itemGuid.

specialRequests
Array of strings

Use instead of specialRequest to send multiple special requests for this item, e.g. ["no salt", "on the side"].

unitOfMeasure
string or null

Unit of measure for the menu item.

Enum: "NONE" "LB" "OZ" "KG" "G"
{
  • "externalId": "string",
  • "itemGuid": "30f474dc-9435-4955-8c48-8707d4e0fbe9",
  • "itemGroupGuid": "93eb340b-ed77-47a1-a49f-68a0f7b01f4a",
  • "quantity": 1,
  • "unitOfMeasure": "NONE",
  • "specialRequest": "string",
  • "specialRequests": [
    ],
  • "modifierSelections": [
    ],
  • "portionModifierSelections": [
    ],
  • "openPriceAmount": 0,
  • "openItemName": "string",
  • "isComplete": true
}