GET

Get Order

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

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/{id}
Path Params
idstringRequired

ID of the order to retrieve.

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.

Response Object
orderOrder

Retrieved order.

Request
cURL
curl -X GET\
    'https://www.wixapis.com/restaurants/v3/orders/64783425355' \
    -H 'Authorization: <AUTH>' \
    -d '{
        "fieldMask": {
              "paths" : [
                "id",
                "customer"
              ]
            }
         }'
Response
JSON
{
  "order": {
    "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": "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?