GET

List Sections

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves sections, given the provided filtering, sorting and paging.

Permissions
Manage Bookings Services and Settings
Manage Restaurant Catalogs
Manage Events
Manage Portfolio
Access Verticals by Automations
Manage Restaurants - all permissions
Read Restaurant Catalogs
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/restaurants/v3/catalogs/{catalogId}/sections
Path Params
catalogIdstringRequired

ID of the catalog the sections belong to.

Query Params
archivedboolean

Whether archived sections are returned. Defaults to false.

Response Object
sectionsArray <Section>

Sections list.

List Section
Request
cURL
curl -X GET \
    'https://www.wixapis.com/restaurants/v3/catalogs/4d088f16-d341-44b2-ac69-ae8f3e8897fd/sections' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: <AUTH>' \
Response
JSON
{
  "sections": [
    {
      "id": "dd53b918-76ed-11ec-90d6-0242ac120003",
      "menuId": "6750e1bd-4434-4603-9a43-d0821d14aac6",
      "name": "ANTIPASTI",
      "description": "This is a section of your menu. Give your section a brief description",
      "itemIds": {
        "values": [
          "382931c7-40db-44c6-af3f-e080aa69e0aa",
          "4446abd1-2643-47d1-9c82-2f841191a41c",
          "078f8ea9-7aed-442e-b386-63129633e197",
          "fc4a29fb-3a3d-4cc0-92d1-a6351c4bc4e7"
        ]
      },
      "visibilityCriteria": {
        "visible": true,
        "fulfillmentTypes": ["DELIVERY", "PICKUP_OR_DINE_IN"],
        "platforms": [
          "WIX_APP",
          "CALL_CENTER",
          "CHAT_BOT",
          "MOBILE_SITE",
          "SITE"
        ]
      },
      "archived": false
    },
    {
      "id": "e3993910-76ed-11ec-90d6-0242ac120003",
      "menuId": "6750e1bd-4434-4603-9a43-d0821d14aac6",
      "name": "PIZZAS",
      "description": "This is a section of your menu. Give your section a brief description",
      "itemIds": {
        "values": [
          "865925f8-c284-47a8-97d1-8b71b5a6c8d8",
          "758464b5-db9a-4e17-b4ce-8ac5694d1355",
          "21425310-2e9d-4d08-a5d2-2885c0bac781",
          "06efbf36-4c2e-456f-9d5a-ec051ef99c3d",
          "618d5633-1e0c-4715-bddf-ae1f81fc4c52",
          "caa36137-41e5-4696-8afc-ff38343319c7",
          "dbe1b7f4-583f-408e-92fb-8419bc378a4d"
        ]
      },
      "visibilityCriteria": {
        "visible": true,
        "fulfillmentTypes": ["DELIVERY", "PICKUP_OR_DINE_IN"],
        "platforms": [
          "WIX_APP",
          "CALL_CENTER",
          "CHAT_BOT",
          "MOBILE_SITE",
          "SITE"
        ]
      },
      "archived": false
    }
  ]
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?