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 order is fulfilled.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.restaurants.v3.order.
Event name. Expected fulfilled.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"data": {
"eventType": "wix.restaurants.v3.order_order-fulfilled",
"instanceId": "<app-instance-id>",
"data": "<stringified-JSON>",
// The identity field is sent as a stringified JSON
"identity": {
"identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
"anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
"memberId": "<memberId>", // in case of MEMBER
"wixUserId": "<wixUserId>", // in case of WIX_USER
"appId": "<appId>" // in case of APP
}
}
}{
"id": "52269077-05f2-4b59-ba4f-36ef8c4c1e11",
"entityFqdn": "wix.restaurants.v3.order",
"slug": "fulfilled",
"actionEvent": {
"bodyAsJson": {
"order": {
"id": "64783425355",
"createdDate": "2021-07-22T12:35:51.675Z",
"updatedDate": "2021-07-07T12:37:44.994Z",
"comment": "call when arriving to building",
"currency": "USD",
"status": "FULFILLED",
"lineItems": [
{
"quantity": 3,
"price": "2.00",
"comment": null,
"dishOptions": [
{
"name": "Taco Options",
"minChoices": 0,
"maxChoices": 3,
"type": "EXTRAS",
"availableChoices": [
{
"itemId": "2b5131cd-7872-4ee8-ae40-cb00c6dcaec1",
"price": "1.00"
},
{
"itemId": "d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40",
"price": "1.50"
},
{
"itemId": "0f3fee4d-1b4a-4cfd-9c79-11a52e8e4024",
"price": "1.50"
}
],
"defaultChoices": [],
"selectedChoices": [
{
"quantity": 1,
"price": "1.50",
"comment": null,
"dishOptions": [],
"catalogReference": {
"catalogItemId": "d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40",
"catalogItemName": "Fried Beans",
"catalogItemDescription": null,
"catalogItemMedia": null
}
}
]
}
],
"catalogReference": {
"catalogItemId": "142bddf2-4462-43c3-b048-4fc5afd5e4f8",
"catalogItemName": "Beef Steak Taco",
"catalogItemDescription": "with fresh veggies and Roasted Tomato Salsa",
"catalogItemMedia": "https://static.wixstatic.com/media/cae3dea6ebc54972a96284b90dd97d73.jpg"
}
},
{
"quantity": 6,
"price": "2.00",
"comment": null,
"dishOptions": [],
"catalogReference": {
"catalogItemId": "2f941cff-0f42-4fbc-90a2-7ceed8a8628b",
"catalogItemName": "Chicken Taco",
"catalogItemDescription": "with fresh veggies and Roasted Tomato Salsa",
"catalogItemMedia": "https://static.wixstatic.com/media/11062bA4cabfdc2652413d92990cfac29777cc~mv2.jpg"
}
},
{
"quantity": 5,
"price": "6.00",
"comment": null,
"dishOptions": [
{
"name": "Taco Options",
"minChoices": 0,
"maxChoices": 2147483647,
"type": "EXTRAS",
"availableChoices": [
{
"itemId": "2b5131cd-7872-4ee8-ae40-cb00c6dcaec1",
"price": "1.00"
},
{
"itemId": "d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40",
"price": "1.50"
},
{
"itemId": "0f3fee4d-1b4a-4cfd-9c79-11a52e8e4024",
"price": "1.50"
}
],
"defaultChoices": [],
"selectedChoices": []
}
],
"catalogReference": {
"catalogItemId": "d6682658-c859-470c-9ef1-500969a486c9",
"catalogItemName": "Chicken Burrito",
"catalogItemDescription": "with rice, beans and lettuce",
"catalogItemMedia": "https://static.wixstatic.com/media/11062bB944af5efcf44457b21a274f61a65316~mv2.jpg"
}
}
],
"discounts": [
{
"catalogDiscountId": "bc697347-c180-494b-b68d-bc63ac63a84b",
"appliedAmount": "15.00",
"catalogDiscountType": "OFF_ORDER",
"catalogDiscountName": "Sunday Order Discount"
}
],
"payments": [
{
"type": "WIX_PAYMENTS",
"amount": "33.00",
"method": "offline",
"providerTransactionId": "55d1ff37-7e9c-4c0f-9ec4-7d6d267019a4"
}
],
"fulfillment": {
"type": "DELIVERY",
"promisedTime": "2021-07-22T13:00:51.675Z",
"asap": true,
"deliveryDetails": {
"charge": "0.00",
"address": {
"formatted": "235 W 23rd St, New York, NY 10011, United States",
"country": null,
"city": "New York",
"street": "West 23rd Street",
"streetNumber": "235",
"apt": null,
"floor": null,
"entrance": null,
"zipCode": "10011",
"countryCode": "US",
"onArrival": "UNSPECIFIED_ON_ARRIVAL_TYPE",
"approximate": false,
"comment": null,
"location": {
"latitude": 40.74481129999999,
"longitude": -73.99674399999999
},
"addressLine2": null
}
}
},
"customer": {
"firstName": "John",
"lastName": "Smith",
"phone": "2075556300",
"email": "john@example.com",
"contactId": "8046df3c-7575-4098-a5ab-c91ad8f33c47"
},
"totals": {
"subtotal": "10.00",
"total": "10.00",
"delivery": null,
"tax": null,
"discount": null,
"loyaltySavings": null,
"quantity": 1,
"tip": null
},
"activities": [
{
"timestamp": "2021-07-07T10:37:44.994Z",
"message": "new"
},
{
"timestamp": "2021-07-07T10:39:46.994Z",
"message": "accepted []"
},
{
"timestamp": "2021-07-07T10:50:55.994Z",
"message": "fulfilled"
}
],
"channelInfo": {
"type": "WEB"
},
"coupon": null,
"loyaltyInfo": null
}
}
},
"entityId": "64783425355",
"eventTime": "2021-07-07T10:47:44.994Z",
"triggeredByAnonymizeRequest": false
}