Product

  • Integer numbers.

  • Integer numbers.

  • Integer numbers.

  • Ingredients the product comes with. null means the product has never been configured; a configured group with nothing currently available returns items: [].

    Each item points at a product already present in one of this product's first-level product_groups, identified by the pair product_group_id + product_id. The same product can appear once in each of several groups, so always match on the pair.

    See Included ingredients for the cart rules that go with this.

    Properties: 3
  • The product is a link to another product rather than a standalone one. Its details come from the product it points at.

  • Integer numbers.

  • Properties: 9
  • Where the product sits when its parent group is split into named sections. null when the group is not sectioned.

    Properties: 2
  • Integer numbers.

  • Integer numbers.

  • When this product is available, if it is restricted to particular times of day. An empty array means no restriction.

  • Integer numbers.

Examples
{
  "id": "348f71da-ffa3-4736-a749-fcdfef212ad5",
  "name": "Build Your Own Pizza Meal",
  "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": 63500,
  "price_id": "cfedaecd-1bb9-49f8-85f2-7075f270339e",
  "tax_rates": [],
  "alcohol_vol_percentage": null,
  "is_alcoholic": false,
  "has_upsell": false,
  "attributes": {},
  "image": null,
  "product_groups": [
    {
      "id": "88d9629e-0c93-43ed-938d-0ecabf758dbf",
      "type": 3,
      "name": "Sides Choice",
      "description": null,
      "external_id": null,
      "state": 1,
      "attributes": {
        "min_quantity": 0,
        "max_quantity": null,
        "max_single_quantity": null
      },
      "image": null,
      "products": [
        {
          "id": "1633865a-3c79-45c9-be06-5c71148b6bda",
          "name": "Fries",
          "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": 300,
          "price": 58200,
          "price_id": "bbc93334-08b0-45c5-ba59-97b476498a65",
          "tax_rates": [],
          "alcohol_vol_percentage": null,
          "is_alcoholic": false,
          "has_upsell": false,
          "attributes": {
            "max_quantity": null,
            "preselected_quantity": null
          },
          "image": null,
          "product_groups": []
        },
        {
          "id": "d67d8f02-dbbd-4b73-8352-c67792b3d88c",
          "name": "Large Fries",
          "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": 500,
          "price": 58300,
          "price_id": "11a82d87-5c91-440c-9591-52e7c73ed96d",
          "tax_rates": [],
          "alcohol_vol_percentage": null,
          "is_alcoholic": false,
          "has_upsell": false,
          "attributes": {
            "max_quantity": null,
            "preselected_quantity": null
          },
          "image": null,
          "product_groups": []
        },
        {
          "id": "a24bf788-eb37-463d-bfc7-fce8df1a0e33",
          "name": "Side Salad",
          "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": 600,
          "price": 58400,
          "price_id": "92d75016-c393-44c3-a83f-d54d0140a2ca",
          "tax_rates": [],
          "alcohol_vol_percentage": null,
          "is_alcoholic": false,
          "has_upsell": false,
          "attributes": {
            "max_quantity": null,
            "preselected_quantity": null
          },
          "image": null,
          "product_groups": [
            {
              "id": "f5628743-22dc-428e-9d51-85d0c85c125b",
              "type": 1,
              "name": "Dressing",
              "description": null,
              "external_id": null,
              "state": 1,
              "attributes": {
                "min_quantity": 0,
                "max_quantity": 1,
                "max_single_quantity": null
              },
              "image": null,
              "products": [
                {
                  "id": "37f10451-f07e-4506-9df1-03d987ec863a",
                  "name": "Housemade Hidden Valley Ranch",
                  "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": 100,
                  "price": 100,
                  "price_id": "b0b014e1-b9e5-4749-b67a-63c5e3048fea",
                  "tax_rates": [],
                  "alcohol_vol_percentage": null,
                  "is_alcoholic": false,
                  "has_upsell": false,
                  "attributes": {
                    "max_quantity": null,
                    "preselected_quantity": null
                  },
                  "image": null,
                  "product_groups": []
                },
                {
                  "id": "aeae8ceb-5b8a-4604-8714-7f864bf4e4e4",
                  "name": "No Dressing",
                  "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": null,
                  "price": 200,
                  "price_id": "5461b422-3daf-4869-8238-07c9c30bfef2",
                  "tax_rates": [],
                  "alcohol_vol_percentage": null,
                  "is_alcoholic": false,
                  "has_upsell": false,
                  "attributes": {
                    "max_quantity": null,
                    "preselected_quantity": null
                  },
                  "image": null,
                  "product_groups": []
                }
              ]
            },
            {
              "id": "bbaacb28-2831-4a38-8212-8e2e55ca5b3e",
              "type": 1,
              "name": "Customize Salad",
              "description": null,
              "external_id": null,
              "state": 1,
              "attributes": {
                "min_quantity": 0,
                "max_quantity": null,
                "max_single_quantity": null
              },
              "image": null,
              "products": [
                {
                  "id": "922e889b-6452-48cc-b78f-1b2d7ce06bd1",
                  "name": "Remove Diced Tomatos",
                  "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": 5,
                  "price": 300,
                  "price_id": "e55e6502-7a6b-497e-b366-5a377bb5bb06",
                  "tax_rates": [],
                  "alcohol_vol_percentage": null,
                  "is_alcoholic": false,
                  "has_upsell": false,
                  "attributes": {
                    "max_quantity": null,
                    "preselected_quantity": null
                  },
                  "image": null,
                  "product_groups": []
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}