Operations: Supported Filters and Sorting

The following table shows field support for filters and sorting for the operations object:

FieldSupported FiltersSortable
id$eq, $ne, $in, $nin, $startsWithSortable
createdDate$eq, $ne, $in, $nin, $startsWith, $lt, $lte, $gt, $gteSortable
updatedDate$eq, $ne, $in, $nin, $startsWith, $lt, $lte, $gt, $gteSortable
name$eq, $ne, $in, $nin, $startsWithSortable
enabled$eq, $ne, $in, $nin
fulfillmentIds$isEmpty, $hasAll, $hasSome
serviceFeeRuleIds$isEmpty, $hasAll, $hasSome
defaultFulfillmentType$eq, $ne, $in, $nin, $startsWith
onlineOrderingStatus$eq, $ne, $in, $nin, $startsWith

Related content: API Query Language, Query Rules

Was this helpful?
Yes
No

Operation Object

An operation is a service a restaurant offers that includes various aspects of its online ordering. You can define default fulfillments, service fees, and scheduling requirements for each operation.

Properties
idstringRead-onlyformat GUID
Operation ID.

revisionintegerRead-onlyformat int64
Revision number. Increments by 1 each time the operation is updated. To prevent conflicting changes, the existing revision must be passed when updating an operation.

createdDatestringRead-onlyformat date-time
Date and time the operation was created.

updatedDatestringRead-onlyformat date-time
Date and time the operation was updated.

namestring
Operation name.

defaultboolean
Whether the operation is the default operation.
Default: false.

fulfillmentIdsArray <string>format GUID
IDs of the fulfillment methods associated with the operation.

onlineOrderingStatusstring
4 enum supported values:
UNDEFINED_ONLINE_ORDERING_STATUSENABLEDDISABLEDPAUSED_UNTIL
Online ordering status of the operation.
  • ENABLED: Operation currently accepts online orders.
  • DISABLED: Operation currently does not accept online orders.
  • PAUSED_UNTIL: Operation currently does not accept online orders, but will accept online orders from a specifed time and date. When applied, pausedUntilOptions is a required field.
  • UNDEFINED_ONLINE_ORDERING_STATUS: Online ordering status is not defined.

serviceFeeRuleIdsArray <string>format GUIDmaxItems 500
IDs of the service fee rules associated with the operation.

defaultFulfillmentTypestring
3 enum supported values:
UNDEFINED_FULFILLMENT_TYPEPICKUPDELIVERY
Default fulfillment type of the operation.

orderSchedulingobject
Information about when an order can be placed for.

ONE OF:


pausedUntilOptionsobject
Options for online ordering status. Required when onlineOrderingStatus is PAUSED_UNTIL.
Was this helpful?
Yes
No

GetList Operations

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.

Endpoint
GET
https://www.wixapis.com/restaurants-operations/v1/operations

Was this helpful?
Yes
No

PostCreate 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.

Creates a new operation.

Endpoint
POST
https://www.wixapis.com/restaurants-operations/v1/operations

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

GetGet 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 an operation.

Endpoint
GET
https://www.wixapis.com/restaurants-operations/v1/operations/{operationId}

Was this helpful?
Yes
No

DeleteDelete 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.

Deletes an operation.

Endpoint
DELETE
https://www.wixapis.com/restaurants-operations/v1/operations/{operationId}

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PatchUpdate 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.

Updates an operation.

If you update part of the orderScheduling property, the whole object is overwritten, so you must include the entire object unless you are not updating orderScheduling at all.

Each time the operation is updated, revision increments by 1. The current revision must be passed when updating the operation. This ensures you're working with the latest operation and prevents unintended overwrites.

Endpoint
PATCH
https://www.wixapis.com/restaurants-operations/v1/operations/{operation.id}

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PostQuery 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.

Endpoint
POST
https://www.wixapis.com/restaurants-operations/v1/operations/query

Was this helpful?
Yes
No

Operation Created

Developer Preview

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

Triggered when an operation is created.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring
Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.restaurants.operations.v1.operation.

slugstring
Event name. Expected created.

entityIdstring
ID of the entity associated with the event.

eventTimestringformat date-time
Event timestamp.

triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).

originatedFromstring
If present, indicates the action that triggered the event.

createdEventobject
Event information.

Was this helpful?
Yes
No

Operation Updated

Developer Preview

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

Triggered when an operation is updated.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring
Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.restaurants.operations.v1.operation.

slugstring
Event name. Expected updated.

entityIdstring
ID of the entity associated with the event.

eventTimestringformat date-time
Event timestamp.

triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).

originatedFromstring
If present, indicates the action that triggered the event.

updatedEventobject
Event information.

Was this helpful?
Yes
No

Operation Deleted

Developer Preview

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

Triggered when an operation is deleted.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring
Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.restaurants.operations.v1.operation.

slugstring
Event name. Expected deleted.

entityIdstring
ID of the entity associated with the event.

eventTimestringformat date-time
Event timestamp.

triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).

originatedFromstring
If present, indicates the action that triggered the event.

deletedEventstruct
Event information.

Was this helpful?
Yes
No