POST

Bulk Create 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.

Adds multiple sections to a draft catalog.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Restaurant Catalogs
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/restaurants/v3/draft-catalogs/{catalogId}/bulk/sections/create
Path Params
catalogIdstringRequired

ID of the catalog the sections will belong to.

Body Params
createSectionRequestsArray <CreateSectionRequest>minItems 1maxItems 20

Information about the sections to create. Limited to 20 sections.

returnFullEntityboolean

Whether the full section entity is returned. Defaults to true.

Response Object
resultsArray <BulkSectionResult>

Information about the created sections.

bulkActionMetadataBulkActionMetadata

Bulk Create Sections metadata.

Bulk Create Sections
Request
cURL
curl -X POST \
    'https://www.wixapis.com/restaurants/v3/draft-catalogs/4d088f16-d341-44b2-ac69-ae8f3e8897fd/bulk/sections/create' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: <AUTH>' \
    --data-raw '{
      "returnFullEntity": true,
      "createSectionRequests": [
        {
          "menuId": "6750e1bd-4434-4603-9a43-d0821d14aac6",
          "section": {
            "name": "ANTIPASTI",
            "description": "This is a section of your menu. Give your section a brief description",
            "imageUrl": null,
            "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"
              ],
              "availability": null
            }
          }
        }
      ]
    }'
Response
JSON
{
  "results": [
    {
      "entityMetadata": {
        "id": "dd53b918-76ed-11ec-90d6-0242ac120003",
        "originalIndex": 0,
        "success": true,
        "error": null
      },
      "entity": {
        "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",
        "imageUrl": null,
        "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"
          ],
          "availability": null
        },
        "archived": false
      }
    }
  ],
  "bulkActionMetadata": {
    "totalSuccesses": 1,
    "totalFailures": 0,
    "undetailedFailures": 0
  }
}
Errors

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

Did this help?