GET

List Orders

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 up to 1000 orders, given the provided filters.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Bookings Services and Settings
Manage Orders
Read Orders
Manage Portfolio
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/restaurants/v3/orders
Query Params
fieldMaskFieldMask

Set of fields to retrieve. Fields that aren't included in fieldmaks.paths are ignored. See the article about field masks for more details.

statusstring

Order status. Currently, it is not possible to filter by status FULFILLED.

createdDatestring

Order creation date and time. Must include a gte: or lte: prefix, for example: gte:2021-10-26T12:48:15Z.

deliveredboolean

Whether the order has been delivered.

locationIdsArray <string>

Location filter. Pass an array of location IDs to return orders with any of the provided locations.

sort.fieldNamestring

Field to sort by.

sort.orderstring

Sort order.

limitinteger

Number of orders to return. The minimum limit is 1, the maximum 1000.

Response Object
ordersArray <Order>

List of retrieved orders.

Request
cURL
curl -X GET \
    'https://www.wixapis.com/restaurants/v3/orders' \
    -H 'Authorization: <AUTH>' \
    -d '{
            "fieldMask": {
                  "paths" : [
                    "id",
                    "customer"
                  ]
                }
             }'
Response
JSON
{
  "orders": [
    {
      "id": "64783425355",
      "createdDate": null,
      "updatedDate": null,
      "comment": null,
      "currency": null,
      "status": "UNSPECIFIED_ORDER_STATUS",
      "lineItems": [],
      "discounts": [],
      "payments": [],
      "fulfillment": null,
      "customer": {
        "firstName": "John",
        "lastName": "Smith",
        "phone": "2075556300",
        "email": "john@example.com",
        "contactId": "9074ef3c-8686-4098-a5ab-c91cv4f44a58"
      },
      "totals": null,
      "activities": [],
      "channelInfo": null,
      "coupon": null,
      "loyaltyInfo": null
    },
    {
      "id": "759510479071",
      "createdDate": null,
      "updatedDate": null,
      "comment": null,
      "currency": null,
      "status": "UNSPECIFIED_ORDER_STATUS",
      "lineItems": [],
      "discounts": [],
      "payments": [],
      "fulfillment": null,
      "customer": {
        "firstName": "Jane",
        "lastName": "Smith",
        "phone": "2315556426",
        "email": "janeSmith2@example.com",
        "contactId": "8046df3c-7575-4098-a5ab-c91ad8f33c47"
      },
      "totals": null,
      "activities": [],
      "channelInfo": null,
      "coupon": null,
      "loyaltyInfo": null
    }
  ]
}
Errors

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

Did this help?