POST

Bulk Archive Menus

Developer Preview

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

Changes the archived boolean to true for multiple menus in 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/menus/archive
Path Params
catalogIdstringRequired

ID of the catalog the menus belong to.

Body Params
idsArray <string>minItems 1maxItems 20

IDs of the menus to archive.

returnFullEntityboolean

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

Response Object
resultsArray <BulkMenuResult>

Information about the archived menus.

bulkActionMetadataBulkActionMetadata

Bulk Archive Menus metadata.

Bulk Archive Menus
Request
cURL
curl -X POST \
    'https://www.wixapis.com/restaurants/v3/draft-catalogs/4d088f16-d341-44b2-ac69-ae8f3e8897fd/bulk/menus/archive' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: <AUTH>' \
    --data-raw '{
      "ids": [
        "6750e1bd-4434-4603-9a43-d0821d14aac6"
      ],
      "returnFullEntity": true
    }'
Response
JSON
{
  "results": [
    {
      "entityMetadata": {
        "id": "6750e1bd-4434-4603-9a43-d0821d14aac6",
        "originalIndex": 0,
        "success": true,
        "error": null
      },
      "entity": {
        "id": "-10",
        "name": "MAIN MENU",
        "description": "",
        "imageUrl": null,
        "visibilityCriteria": {
          "visible": true,
          "fulfillmentTypes": ["DELIVERY", "PICKUP_OR_DINE_IN"],
          "platforms": [
            "WIX_APP",
            "CALL_CENTER",
            "CHAT_BOT",
            "MOBILE_SITE",
            "SITE"
          ],
          "availability": null
        },
        "sectionIds": {
          "values": [
            "dd53b918-76ed-11ec-90d6-0242ac120003",
            "e3993910-76ed-11ec-90d6-0242ac120003"
          ]
        },
        "archived": true
      }
    }
  ],
  "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?