POST

Query Operation

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 a list of operations, given the provided paging, filtering, and sorting.

Query Operation runs with these defaults, which you can override:

  • paging.limit is 50
  • sort.order is ASC

For field support for filters and sorting, see Operations: Supported Filters and Sorting.

To learn about working with Query endpoints, see API Query Language, Sorting and Paging, and Field Projection.

Permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/restaurants-operations/v1/operations/query
Body Params
queryQueryRequired

Query options.

Response Object
operationsArray <Operation>

Retrieved operations.

pagingMetadataPagingMetadata

Metadata of the paginated results.

Query Operation Example 1
Request
cURL
curl -X POST https://www.wixapis.com/restaurants-operations/v1/operations/query \
    -H 'Content-Type: application/json' \
    -H 'Authorization: <AUTH>' \
    --data-raw '{
                  "query": {
                    "sort": [],
                    "filter": {
                      "name": {
                        "$startsWith": "ASAP"
                      }
                    }
                  }
                }'
Response
JSON
{
  "operations": [
    {
      "id": "48605ac5-53fc-49b4-96b2-87f7636f5ce0",
      "revision": "4",
      "createdDate": "2023-11-27T06:51:54.146Z",
      "updatedDate": "2023-12-03T13:18:04.382Z",
      "name": "Asap operation",
      "enabled": true,
      "orderScheduling": {
        "type": "ASAP",
        "asapOptions": {
          "preparationTime": {
            "type": "MAX_TIME",
            "maxTimeOptions": {
              "timeUnit": "MINUTES",
              "duration": 30
            }
          },
          "asapFutureHandlingType": "BUSINESS_DAYS_AHEAD_HANDLING",
          "businessDaysAheadHandlingOptions": {
            "daysCount": 0
          }
        }
      },
      "profileId": "ad6994d5-a1c5-476d-b39f-c78d3a5444cb",
      "default": true,
      "fulfillmentIds": [
        "12590791-d0d9-418f-a226-a7dcfd37b507",
        "71831b22-a043-4998-a10d-01bf9f2472f2",
        "642dd960-ab45-4eac-ab64-de0ad2215fe0",
        "32e82c15-f518-44e3-800f-406f13f9bb2e"
      ],
      "serviceFeeRuleIds": [],
      "onlineOrderingStatus": "ENABLED"
    }
  ]
}
Errors

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

Did this help?