Product-Group

attributes
Type: object
Properties: 3
description
Type: null
external_id
Type: null
id
Type: string
image
Type: null
is_sections_overridden
Type: boolean

The sections on this group have been overridden for this particular product rather than inherited from the group itself.
name
Type: string
product_sections
Type: array of object

Named sections the group's products are divided into, for rendering a modifier group as headed groups rather than one long list. Empty when the group is not sectioned.

Properties: 4
products
Type: array of object
Properties: 21
state
Type: integer

Integer numbers.
type
Type: integer

Integer numbers.

Examples

{
  "id": "3406581e-818a-4efc-8c3a-4f350873340c",
  "type": 1,
  "name": "Pick 1 Optional Syrup or Sauce",
  "description": null,
  "external_id": null,
  "state": 1,
  "attributes": {
    "min_quantity": 0,
    "max_quantity": 1,
    "max_single_quantity": null
  },
  "image": null,
  "products": [
    {
      "id": "6b8cbab3-1719-4294-a912-4527bed6b75c",
      "name": "Caramel Topping",
      "description": null,
      "external_id": null,
      "state": 1,
      "temporary_disabled_until": null,
      "pos_state": true,
      "in_stock": true,
      "food_types": null,
      "allergens": [],
      "is_self_serving": false,
      "calories": 200,
      "price": 2100,
      "price_id": "af4f29e6-04d3-41a8-bcee-adc17172eb27",
      "tax_rates": [],
      "alcohol_vol_percentage": null,
      "is_alcoholic": false,
      "has_upsell": false,
      "attributes": {
        "max_quantity": null,
        "preselected_quantity": null
      },
      "image": null,
      "product_groups": []
    },
    {
      "id": "b8f135b1-0af5-4dd2-8c67-31b2e7ff1b76",
      "name": "Chocolaty Topping",
      "description": null,
      "external_id": null,
      "state": 1,
      "temporary_disabled_until": null,
      "pos_state": true,
      "in_stock": true,
      "food_types": null,
      "allergens": [],
      "is_self_serving": false,
      "calories": 290,
      "price": 2200,
      "price_id": "c3fe8bd0-3c2c-49cb-b3c4-cba898ff19a5",
      "tax_rates": [],
      "alcohol_vol_percentage": null,
      "is_alcoholic": false,
      "has_upsell": false,
      "attributes": {
        "max_quantity": null,
        "preselected_quantity": null
      },
      "image": null,
      "product_groups": []
    },
    {
      "id": "c89708c0-6a9d-40cc-9380-3ea405f1f50e",
      "name": "Fudge Topping",
      "description": null,
      "external_id": null,
      "state": 1,
      "temporary_disabled_until": null,
      "pos_state": true,
      "in_stock": true,
      "food_types": null,
      "allergens": [],
      "is_self_serving": false,
      "calories": 80,
      "price": 2300,
      "price_id": "bdf6c8c5-c732-42c2-8a32-a848aa42abf5",
      "tax_rates": [],
      "alcohol_vol_percentage": null,
      "is_alcoholic": false,
      "has_upsell": false,
      "attributes": {
        "max_quantity": null,
        "preselected_quantity": null
      },
      "image": null,
      "product_groups": []
    },
    {
      "id": "380ba5d9-cf83-4b46-a36a-09d47a662ac6",
      "name": "Peanut Butter Topping",
      "description": null,
      "external_id": null,
      "state": 1,
      "temporary_disabled_until": null,
      "pos_state": true,
      "in_stock": true,
      "food_types": null,
      "allergens": [],
      "is_self_serving": false,
      "calories": 220,
      "price": 2400,
      "price_id": "0a65e1d6-72a7-4c50-a962-722c44f60b42",
      "tax_rates": [],
      "alcohol_vol_percentage": null,
      "is_alcoholic": false,
      "has_upsell": false,
      "attributes": {
        "max_quantity": null,
        "preselected_quantity": null
      },
      "image": null,
      "product_groups": []
    },
    {
      "id": "113f284f-fdeb-49f2-920b-be8d9b1a8c0d",
      "name": "Strawberry Topping",
      "description": null,
      "external_id": null,
      "state": 1,
      "temporary_disabled_until": null,
      "pos_state": true,
      "in_stock": true,
      "food_types": null,
      "allergens": [],
      "is_self_serving": false,
      "calories": 250,
      "price": 2500,
      "price_id": "2093ec79-c3cd-4129-a4f1-c8332a1a1e01",
      "tax_rates": [],
      "alcohol_vol_percentage": null,
      "is_alcoholic": false,
      "has_upsell": false,
      "attributes": {
        "max_quantity": null,
        "preselected_quantity": null
      },
      "image": null,
      "product_groups": []
    }
  ]
}

Product

Introduction