The Availability Exceptions API allows you to create and manage availability exceptions for restaurant operations. Availability exceptions are time periods during which the restaurant's Wix site can’t fulfill orders for the operation. An availability exception can block all fulfillment methods during the time period, or only specific fulfillment methods.
For example, you could use availability exceptions to:
With the Availability Exceptions API, you can create and manage availability exceptions.
It’s important to note the following points before starting to code:
operationID
of a restaurant's operation.The following table shows field support for filters and sorting for the availability exceptions 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 |
startTime | $eq , $ne , $in , $nin , $startsWith , $lt , $lte , $gt , $gte | Sortable |
endTime | $eq , $ne , $in , $nin , $startsWith , $lt , $lte , $gt , $gte | Sortable |
available | $eq , $ne , $in , $nin | |
name | $eq , $ne , $in , $nin , $startsWith | Sortable |
affectedFulfillmentMethods.affectedMethods | $eq , $ne , $in , min , $startsWith |
Related content: API Query Language, Query Availability Exceptions
Availability exception ID.
Revision number, which increments by 1 each time the availability exception is updated. To prevent conflicting changes, the current revision must be specified when updating the availability exception.
Date and time the availability exception was created in ISO-8601 format.
Date and time the availability exception was last updated in ISO-8601 format.
The start time of the availability exception in ISO-8601 format.
The end time of the availability exception in ISO-8601 format.
Whether the exception makes the [start_time
, end_time
] range available.
If true
, the exception makes the restaurant available for online ordering during the time range. If false
, the exception makes the restaurant unavailable for ordering during the time range.
Currently, only false
is supported.
Exception name.
Fulfillment methods for which this exception applies.
ID of the restaurant operation this exception is associated with. (See the Restaurants Operations API for more information.)
Extended fields.