Operations: Supported Filters and Sorting
The following table shows field support for filters and sorting for the operations object:
Field | Supported Filters | Sortable |
---|---|---|
id | $eq , $ne , $in , $nin , $startsWith | Sortable |
createdDate | $eq , $ne , $in , $nin , $startsWith , $lt , $lte , $gt , $gte | Sortable |
updatedDate | $eq , $ne , $in , $nin , $startsWith , $lt , $lte , $gt , $gte | Sortable |
name | $eq , $ne , $in , $nin , $startsWith | Sortable |
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
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.
Default: false.
- 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.
ONE OF:
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.
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.
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.
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.
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.
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
is50
sort.order
isASC
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.
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.
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.
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.