POST

Bulk Create Dishes

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 dishes 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/dishes/create
Path Params
catalogIdstringRequired

ID of the catalog the dishes will belong to.

Body Params
createDishRequestsArray <CreateDishRequest>minItems 1maxItems 20

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

returnFullEntityboolean

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

Response Object
resultsArray <BulkItemResult>

Information about the created dishes.

bulkActionMetadataBulkActionMetadata

Bulk Create Dishes metadata.

Bulk Create Dishes
Request
cURL
curl -X POST \
    'https://www.wixapis.com/restaurants/v3/draft-catalogs/4d088f16-d341-44b2-ac69-ae8f3e8897fd/bulk/dishes/create' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: <AUTH>' \
    --data-raw '{
      "returnFullEntity": true,
      "createDishRequests": [
        {
          "menuId": "6750e1bd-4434-4603-9a43-d0821d14aac6",
          "sectionId": "dd53b918-76ed-11ec-90d6-0242ac120003",
          "dish": {
            "name": "MARGHERITA",
            "description": "This is an item on your menu. Give your item a brief description",
            "price": {
              "value": "9.00",
              "currency": "USD"
            },
            "imageUrl": null,
            "labels": {
              "values": [
                "featured"
              ]
            },
            "inStock": true,
            "visibilityCriteria": {
              "visible": true,
              "fulfillmentTypes": [
                "DELIVERY",
                "PICKUP_OR_DINE_IN"
              ],
              "platforms": [
                "WIX_APP",
                "CALL_CENTER",
                "CHAT_BOT",
                "MOBILE_SITE",
                "SITE"
              ],
              "availability": null
            },
            "dishOptions": {
              "values": [
                {
                  "name": "Toppings",
                  "extras": {
                    "defaultChoices": [],
                    "minChoices": 0,
                    "maxChoices": 3,
                    "availableChoices": [
                      {
                        "itemId": "393d56b1-55ac-43de-8493-5e935bc8663f",
                        "price": {
                          "value": "1.00",
                          "currency": "USD"
                        }
                      },
                      {
                        "itemId": "089c1868-3dc4-4633-ad93-3404607add28",
                        "price": {
                          "value": "2.00",
                          "currency": "USD"
                        }
                      },
                      {
                        "itemId": "1a4a1fd0-3029-46df-819b-e3d22dabb5aa",
                        "price": {
                          "value": "3.00",
                          "currency": "USD"
                        }
                      }
                    ]
                  },
                  "type": "EXTRAS"
                }
              ]
            },
            "taxRate": "8.00",
            "acceptSpecialRequest": true,
            "type": "DISH"
          }
        }
      ]
    }'
Response
JSON
{
  "results": [
    {
      "entityMetadata": {
        "id": "865925f8-c284-47a8-97d1-8b71b5a6c8d8",
        "originalIndex": 0,
        "success": true,
        "error": null
      },
      "entity": {
        "id": "865925f8-c284-47a8-97d1-8b71b5a6c8d8",
        "name": "MARGHERITA",
        "description": "This is an item on your menu. Give your item a brief description",
        "price": {
          "value": "9.00",
          "currency": "USD"
        },
        "imageUrl": null,
        "labels": {
          "values": ["featured"]
        },
        "inStock": true,
        "archived": false,
        "visibilityCriteria": {
          "visible": true,
          "fulfillmentTypes": ["DELIVERY", "PICKUP_OR_DINE_IN"],
          "platforms": [
            "WIX_APP",
            "CALL_CENTER",
            "CHAT_BOT",
            "MOBILE_SITE",
            "SITE"
          ],
          "availability": null
        },
        "dishOptions": {
          "values": [
            {
              "name": "Toppings",
              "extras": {
                "defaultChoices": [],
                "minChoices": 0,
                "maxChoices": 3,
                "availableChoices": [
                  {
                    "itemId": "393d56b1-55ac-43de-8493-5e935bc8663f",
                    "price": {
                      "value": "1.00",
                      "currency": "USD"
                    }
                  },
                  {
                    "itemId": "089c1868-3dc4-4633-ad93-3404607add28",
                    "price": {
                      "value": "2.00",
                      "currency": "USD"
                    }
                  },
                  {
                    "itemId": "1a4a1fd0-3029-46df-819b-e3d22dabb5aa",
                    "price": {
                      "value": "3.00",
                      "currency": "USD"
                    }
                  }
                ]
              },
              "type": "EXTRAS"
            }
          ]
        },
        "taxRate": "8.00",
        "acceptSpecialRequest": true,
        "type": "DISH"
      }
    }
  ],
  "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?