Setup
To use the Orders API, install the @wix/restaurants
package using npm or Yarn:
1npm install @wix/restaurants
or
1yarn add @wix/restaurants
Then import { orders }
from @wix/restaurants
:
1import { orders } from '@wix/restaurants'
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Changes the order status to ACCEPTED
.
Note: It is not possible to change the order status from FULFILLED
to ACCEPTED
.
Permission Scopes
For app development, you must have one of the following permission scopes:function acceptOrder(_id: string, options: AcceptOrderOptions): Promise<AcceptOrderResponse>
ID of the order to mark as ACCEPTED.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Changes the order status to CANCELED
.
Permission Scopes
For app development, you must have one of the following permission scopes:function cancelOrder(_id: string, options: CancelOrderOptions): Promise<CancelOrderResponse>
ID of the order to mark as CANCELED.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Changes the order status to FULFILLED
.
Permission Scopes
For app development, you must have one of the following permission scopes:function fulfillOrder(_id: string): Promise<FulfillOrderResponse>
ID of the order to mark as FULFILLED.
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 up to 1000 orders, given the provided filters.
Permission Scopes
For app development, you must have one of the following permission scopes:function listOrders(options: ListOrdersOptions): Promise<ListOrdersResponse>