POST api/Efood/GetEfoodCatalog

No documentation available.

Request Information

Parameters

NameDescriptionAdditional information
identity
No documentation available.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
{
  "guid": "b3eb73de-5f1f-48bd-a27c-5e6c4d9e88fd",
  "ID": 2,
  "ListIDs": [
    1,
    2,
    3
  ],
  "PageNumber": 3,
  "sorting": 4,
  "UserRightID": 5,
  "MaxRows": 6,
  "BranchID": 7,
  "attribute": 8
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'Identity'.

Response Information

No documentation available.

Response body formats

application/json, text/json

Sample:
{
  "Outcome": 0,
  "Message": "sample string 1",
  "Data": {
    "$id": "2",
    "data": {
      "$id": "3",
      "discounts": [
        {
          "$id": "4"
        },
        {
          "$ref": "4"
        },
        {
          "$ref": "4"
        }
      ],
      "offers": [
        {
          "$id": "5"
        },
        {
          "$ref": "5"
        },
        {
          "$ref": "5"
        }
      ],
      "menu": {
        "$id": "6",
        "categories": [
          {
            "$id": "7",
            "code": "sample string 1",
            "description": "sample string 2",
            "has_pending_self_service_changes": true,
            "has_times": true,
            "id": 5,
            "images": {
              "$id": "8"
            },
            "images_meta": [
              {
                "$id": "9"
              },
              {
                "$id": "10"
              },
              {
                "$id": "11"
              }
            ],
            "is_inside_working_hours": true,
            "items": [
              {
                "$id": "12",
                "additional_tax": 1.1,
                "additional_tax_included_in_price": true,
                "allergens": [
                  {
                    "$id": "13"
                  },
                  {
                    "$id": "14"
                  },
                  {
                    "$id": "15"
                  }
                ],
                "allow_comments": true,
                "auto_reset": true,
                "barcode": {
                  "$id": "16"
                },
                "buyer": "sample string 6",
                "buyer_price": 7,
                "category_code": "sample string 8",
                "category_codes": [
                  "sample string 1",
                  "sample string 2",
                  "sample string 3"
                ],
                "category_is_inside_working_hours": true,
                "category_order": 10,
                "code": "sample string 11",
                "commissionable_price": 12.1,
                "dailydish_type": 13,
                "description": "sample string 14",
                "excluded_from_minimum_order": true,
                "food_labelling": {
                  "$id": "17"
                },
                "global_asset": {
                  "$id": "18"
                },
                "has_options": true,
                "has_pending_self_service_changes": true,
                "has_plus_sign": true,
                "has_times": true,
                "has_variations": true,
                "hashcode": "sample string 23",
                "id": 24,
                "images": {
                  "$id": "19",
                  "original": {
                    "$id": "20"
                  },
                  "thumb": {
                    "$id": "21"
                  },
                  "banner": {
                    "$id": "22"
                  },
                  "editable": {
                    "$id": "23"
                  },
                  "featured": {
                    "$id": "24"
                  },
                  "menu": {
                    "$id": "25"
                  },
                  "popular": {
                    "$id": "26"
                  }
                },
                "images_meta": [
                  {
                    "$id": "27"
                  },
                  {
                    "$id": "28"
                  },
                  {
                    "$id": "29"
                  }
                ],
                "is_available": true,
                "is_dailydish": true,
                "is_hidden": true,
                "is_inside_working_hours": true,
                "is_reorder_available": true,
                "material_tags": [
                  {
                    "$id": "30"
                  },
                  {
                    "$id": "31"
                  },
                  {
                    "$id": "32"
                  }
                ],
                "materialtags": "sample string 30",
                "max_quantity_available": 31,
                "max_quantity_per_order": 32,
                "metric_description": "sample string 33",
                "name": "sample string 34",
                "need_server_calculation": true,
                "option_codes": [
                  "sample string 1",
                  "sample string 2",
                  "sample string 3"
                ],
                "order": 36,
                "pos_code": "sample string 37",
                "price": 38.1,
                "price_before_tax": {
                  "$id": "33"
                },
                "price_takeaway": {
                  "$id": "34"
                },
                "printed_name": "sample string 41",
                "pvc_recycling_tax": 42,
                "quick_add": true,
                "schedules": {
                  "$id": "35"
                },
                "shortage": true,
                "size_info": "sample string 46",
                "special_instructions": "sample string 47",
                "tags": [
                  {
                    "$id": "36"
                  },
                  {
                    "$id": "37"
                  },
                  {
                    "$id": "38"
                  }
                ],
                "tiers": [
                  {
                    "$id": "39",
                    "code": 1,
                    "created_at": "2025-10-28T23:05:53.2104025+02:00",
                    "dependency_code": 3,
                    "description": {
                      "$id": "40"
                    },
                    "free_options": 5,
                    "has_pending_self_service_changes": true,
                    "id": 7,
                    "is_deleted": true,
                    "item_code": "sample string 9",
                    "maximum_selections": 10,
                    "name": "sample string 11",
                    "options": [
                      {
                        "$id": "41",
                        "additional_tax": 1,
                        "auto_reset": true,
                        "code": 3,
                        "created_at": "2025-10-28T23:05:53.2104025+02:00",
                        "dependencies": [
                          {
                            "$id": "42"
                          },
                          {
                            "$id": "43"
                          },
                          {
                            "$id": "44"
                          }
                        ],
                        "has_pending_self_service_changes": true,
                        "id": 6,
                        "is_available": true,
                        "is_default": true,
                        "is_deleted": true,
                        "item_code": "sample string 10",
                        "name": "sample string 11",
                        "order": 12,
                        "price": 13.0,
                        "printed_name": "sample string 14",
                        "pvc_recycling_tax": 15,
                        "restaurant_id": 16,
                        "selected": true,
                        "shortage": true,
                        "tier_code": 19,
                        "tier_dependency_code": 20,
                        "updated_at": "2025-10-28T23:05:53.2104025+02:00",
                        "vendor_reference_id": {
                          "$id": "45"
                        },
                        "vendor_reference_metadata": {
                          "$id": "46"
                        }
                      },
                      {
                        "$ref": "41"
                      },
                      {
                        "$ref": "41"
                      }
                    ],
                    "order": 12,
                    "restaurant_id": 13,
                    "shortage": true,
                    "type": "sample string 15",
                    "updated_at": "2025-10-28T23:05:53.2104025+02:00",
                    "vendor_reference_id": {
                      "$id": "47"
                    },
                    "vendor_reference_metadata": {
                      "$id": "48"
                    }
                  },
                  {
                    "$ref": "39"
                  },
                  {
                    "$ref": "39"
                  }
                ],
                "type_details": {
                  "$id": "49"
                },
                "updated_at": "2025-10-28T23:05:53.2104025+02:00",
                "vat": {
                  "$id": "50"
                },
                "vendor_reference_id": "sample string 51",
                "vendor_reference_metadata": {
                  "$id": "51"
                }
              },
              {
                "$ref": "12"
              },
              {
                "$ref": "12"
              }
            ],
            "name": "sample string 8",
            "order": 9,
            "schedules": {
              "$id": "52"
            },
            "tags": [
              "sample string 1",
              "sample string 2",
              "sample string 3"
            ],
            "vendor_reference_id": "sample string 11",
            "vendor_reference_metadata": {
              "$id": "53"
            }
          },
          {
            "$ref": "7"
          },
          {
            "$ref": "7"
          }
        ]
      }
    },
    "status": "sample string 1",
    "error": {
      "$id": "54",
      "code": "sample string 1",
      "message": "sample string 2"
    }
  }
}