{"id":"c5d2813a-3768-4a86-a253-e93be23082dc","createdDate":"2024-01-10T09:01:17.003Z","updatedDate":"2024-01-10T09:01:17.003Z","resourceId":"0f61c670-a569-4683-a32e-db82300d1471","api":{"schema":{"object":{"displayName":"Order Object","description":"","slug":"order-object","$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.Order","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"},"methods":[{"summary":"Get Order","description":"Retrieves an order.","operationId":"com.wixpress.restaurants.orders.v3.OrdersApi.GetOrder","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"ID of the order to retrieve.","x-wix-docs":{"exposure":"PUBLIC"}},{"name":"fieldMask","in":"query","description":"Set of fields to retrieve.\nFields that aren't included in `fieldmaks.paths` are ignored.\nSee [the article about field masks](https://dev.wix.com/api/rest/restaurants/orders/supported-field-masks)\nfor more details.","required":false,"schema":{"title":"fieldMask","description":"Set of fields to retrieve.\nFields that aren't included in `fieldmaks.paths` are ignored.\nSee [the article about field masks](https://dev.wix.com/api/rest/restaurants/orders/supported-field-masks)\nfor more details.","$ref":"#/components/schemas/google.protobuf.FieldMask","x-wix-docs":{"exposure":"PUBLIC"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.GetOrderResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/restaurants/v3/orders","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/restaurants/v3/orders","destinationPath":"/v3/orders","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.restaurants.orders.v3.OrdersApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_RESTAURANTS.READ_ORDERS"],"externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-RESTAURANTS.MANAGE-ORDERS"},{"name":"Read Orders","scopeId":"SCOPE.DC-RESTAURANTS.READ-ORDERS"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Restaurants_MEGASCOPE","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.restaurants:restaurants-orders-webapp","serviceArtifactId":"com.wixpress.restaurants.restaurants-orders-webapp","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.restaurants.orders.v3.GetOrderRequest","responseMessage":"com.wixpress.restaurants.orders.v3.GetOrderResponse"},"legacyExamples":[{"name":"GetOrder","type":"METHOD","content":{"title":"Get Order","request":"curl -X GET \\\n 'https://www.wixapis.com/restaurants/v3/orders/64783425355' \\\n -H 'Authorization: '","response":"{\n \"order\": {\n \"id\": \"64783425355\",\n \"createdDate\": \"2021-04-22T12:35:51.675Z\",\n \"updatedDate\": \"2021-07-07T10:47:44.994Z\",\n \"comment\": \"call when arriving to building\",\n \"currency\": \"USD\",\n \"status\": \"FULFILLED\",\n \"lineItems\": [\n {\n \"quantity\": 5,\n \"price\": \"2.00\",\n \"comment\": null,\n \"dishOptions\": [\n {\n \"name\": \"Taco Options\",\n \"minChoices\": 0,\n \"maxChoices\": 3,\n \"type\": \"EXTRAS\",\n \"availableChoices\": [\n {\n \"itemId\": \"2b5131cd-7872-4ee8-ae40-cb00c6dcaec1\",\n \"price\": \"1.00\"\n },\n {\n \"itemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"price\": \"1.50\"\n },\n {\n \"itemId\": \"0f3fee4d-1b4a-4cfd-9c79-11a52e8e4024\",\n \"price\": \"1.50\"\n }\n ],\n \"defaultChoices\": [],\n \"selectedChoices\": [\n {\n \"quantity\": 1,\n \"price\": \"1.50\",\n \"comment\": null,\n \"dishOptions\": [],\n \"catalogReference\": {\n \"catalogItemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"catalogItemName\": \"Fried Beans\",\n \"catalogItemDescription\": null,\n \"catalogItemMedia\": null\n }\n }\n ]\n }\n ],\n \"catalogReference\": {\n \"catalogItemId\": \"81cddf94-dcad-4f0e-9c3c-7556e3dbd4d8\",\n \"catalogItemName\": \"Chicken Taco\",\n \"catalogItemDescription\": \"with fresh veggies and Roasted Tomato Salsa\",\n \"catalogItemMedia\": \"https://static.wixstatic.com/media/11062bA4cabfdc2652413d92990cfac29777cc~mv2.jpg\"\n }\n }\n ],\n \"discounts\": [],\n \"payments\": [\n {\n \"type\": \"WIX_PAYMENTS\",\n \"amount\": \"10.00\",\n \"method\": \"offline\",\n \"providerTransactionId\": \"d9ef0f0c-e81a-4017-9d6a-977089eb411f\"\n }\n ],\n \"fulfillment\": {\n \"type\": \"DELIVERY\",\n \"promisedTime\": \"2021-04-22T11:20:52.171Z\",\n \"asap\": true,\n \"deliveryDetails\": {\n \"charge\": \"0.00\",\n \"address\": {\n \"formatted\": \"235 W 23rd St, New York, NY 10011, United States\",\n \"country\": null,\n \"city\": \"New York\",\n \"street\": \"West 23rd Street\",\n \"streetNumber\": \"235\",\n \"apt\": \"1\",\n \"floor\": \"3\",\n \"entrance\": null,\n \"zipCode\": \"10011-2302\",\n \"countryCode\": \"US\",\n \"onArrival\": \"UNSPECIFIED_ON_ARRIVAL_TYPE\",\n \"approximate\": false,\n \"comment\": null,\n \"location\": {\n \"latitude\": 40.7448484,\n \"longitude\": -73.9967498\n },\n \"addressLine2\": null\n }\n }\n },\n \"customer\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"phone\": \"2075556300\",\n \"email\": \"john@example.com\",\n \"contactId\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\"\n },\n \"totals\": {\n \"subtotal\": \"10.00\",\n \"total\": \"10.00\",\n \"delivery\": null,\n \"tax\": null,\n \"discount\": null,\n \"loyaltySavings\": null,\n \"quantity\": 1,\n \"tip\": null\n },\n \"activities\": [\n {\n \"timestamp\": \"2021-07-07T10:37:44.994Z\",\n \"message\": \"new\"\n },\n {\n \"timestamp\": \"2021-07-07T10:39:46.994Z\",\n \"message\": \"accepted []\"\n },\n {\n \"timestamp\": \"2021-07-07T10:50:55.994Z\",\n \"message\": \"fulfilled\"\n }\n ],\n \"channelInfo\": {\n \"type\": \"WEB\"\n },\n \"coupon\": null,\n \"loyaltyInfo\": null\n }\n}"}},{"name":"GetOrder","type":"METHOD","order":2,"content":{"title":"Get Order (Only order id and line items)","request":"curl -X GET\\\n 'https://www.wixapis.com/restaurants/v3/orders/64783425355' \\\n -H 'Authorization: ' \\\n -d '{\n \"fieldMask\": {\n \"paths\" : [\n \"id\",\n \"lineItems\"\n ]\n }\n }'","response":"{\n \"order\": {\n \"id\": \"64783425355\",\n \"createdDate\": null,\n \"updatedDate\": null,\n \"comment\": null,\n \"currency\": null,\n \"status\": \"UNSPECIFIED_ORDER_STATUS\",\n \"lineItems\": [\n {\n \"quantity\": 5,\n \"price\": \"2.00\",\n \"comment\": null,\n \"dishOptions\": [\n {\n \"name\": \"Taco Options\",\n \"minChoices\": 0,\n \"maxChoices\": 3,\n \"type\": \"EXTRAS\",\n \"availableChoices\": [\n {\n \"itemId\": \"2b5131cd-7872-4ee8-ae40-cb00c6dcaec1\",\n \"price\": \"1.00\"\n },\n {\n \"itemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"price\": \"1.50\"\n },\n {\n \"itemId\": \"0f3fee4d-1b4a-4cfd-9c79-11a52e8e4024\",\n \"price\": \"1.50\"\n }\n ],\n \"defaultChoices\": [],\n \"selectedChoices\": [\n {\n \"quantity\": 1,\n \"price\": \"1.50\",\n \"comment\": null,\n \"dishOptions\": [],\n \"catalogReference\": {\n \"catalogItemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"catalogItemName\": \"Fried Beans\",\n \"catalogItemDescription\": null,\n \"catalogItemMedia\": null\n }\n }\n ]\n }\n ],\n \"catalogReference\": {\n \"catalogItemId\": \"81cddf94-dcad-4f0e-9c3c-7556e3dbd4d8\",\n \"catalogItemName\": \"Chicken Taco\",\n \"catalogItemDescription\": \"with fresh veggies and Roasted Tomato Salsa\",\n \"catalogItemMedia\": \"https://static.wixstatic.com/media/11062bA4cabfdc2652413d92990cfac29777cc~mv2.jpg\"\n }\n }\n ],\n \"discounts\": [],\n \"payments\": [],\n \"fulfillment\": null,\n \"customer\": null,\n \"totals\": null,\n \"activities\": [],\n \"channelInfo\": null,\n \"coupon\": null,\n \"loyaltyInfo\": null\n }\n}"}},{"name":"GetOrder","type":"METHOD","order":1,"content":{"title":"Get Order with Field Masks","request":"curl -X GET\\\n 'https://www.wixapis.com/restaurants/v3/orders/64783425355' \\\n -H 'Authorization: ' \\\n -d '{\n \"fieldMask\": {\n \"paths\" : [\n \"id\",\n \"customer\"\n ]\n }\n }'","response":"{\n \"order\": {\n \"id\": \"64783425355\",\n \"createdDate\": null,\n \"updatedDate\": null,\n \"comment\": null,\n \"currency\": null,\n \"status\": \"UNSPECIFIED_ORDER_STATUS\",\n \"lineItems\": [],\n \"discounts\": [],\n \"payments\": [],\n \"fulfillment\": null,\n \"customer\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"phone\": \"2075556300\",\n \"email\": \"john@example.com\",\n \"contactId\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n },\n \"totals\": null,\n \"activities\": [],\n \"channelInfo\": null,\n \"coupon\": null,\n \"loyaltyInfo\": null\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"},"httpMethod":"get","path":"/v3/orders/{id}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.restaurants.orders.v3.OrdersApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_RESTAURANTS.READ_ORDERS"],"externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-RESTAURANTS.MANAGE-ORDERS"},{"name":"Read Orders","scopeId":"SCOPE.DC-RESTAURANTS.READ-ORDERS"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Restaurants_MEGASCOPE","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.restaurants:restaurants-orders-webapp","serviceArtifactId":"com.wixpress.restaurants.restaurants-orders-webapp","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.restaurants.orders.v3.GetOrderRequest","responseMessage":"com.wixpress.restaurants.orders.v3.GetOrderResponse"},"legacyExamples":[{"name":"GetOrder","type":"METHOD","content":{"title":"Get Order","request":"curl -X GET \\\n 'https://www.wixapis.com/restaurants/v3/orders/64783425355' \\\n -H 'Authorization: '","response":"{\n \"order\": {\n \"id\": \"64783425355\",\n \"createdDate\": \"2021-04-22T12:35:51.675Z\",\n \"updatedDate\": \"2021-07-07T10:47:44.994Z\",\n \"comment\": \"call when arriving to building\",\n \"currency\": \"USD\",\n \"status\": \"FULFILLED\",\n \"lineItems\": [\n {\n \"quantity\": 5,\n \"price\": \"2.00\",\n \"comment\": null,\n \"dishOptions\": [\n {\n \"name\": \"Taco Options\",\n \"minChoices\": 0,\n \"maxChoices\": 3,\n \"type\": \"EXTRAS\",\n \"availableChoices\": [\n {\n \"itemId\": \"2b5131cd-7872-4ee8-ae40-cb00c6dcaec1\",\n \"price\": \"1.00\"\n },\n {\n \"itemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"price\": \"1.50\"\n },\n {\n \"itemId\": \"0f3fee4d-1b4a-4cfd-9c79-11a52e8e4024\",\n \"price\": \"1.50\"\n }\n ],\n \"defaultChoices\": [],\n \"selectedChoices\": [\n {\n \"quantity\": 1,\n \"price\": \"1.50\",\n \"comment\": null,\n \"dishOptions\": [],\n \"catalogReference\": {\n \"catalogItemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"catalogItemName\": \"Fried Beans\",\n \"catalogItemDescription\": null,\n \"catalogItemMedia\": null\n }\n }\n ]\n }\n ],\n \"catalogReference\": {\n \"catalogItemId\": \"81cddf94-dcad-4f0e-9c3c-7556e3dbd4d8\",\n \"catalogItemName\": \"Chicken Taco\",\n \"catalogItemDescription\": \"with fresh veggies and Roasted Tomato Salsa\",\n \"catalogItemMedia\": \"https://static.wixstatic.com/media/11062bA4cabfdc2652413d92990cfac29777cc~mv2.jpg\"\n }\n }\n ],\n \"discounts\": [],\n \"payments\": [\n {\n \"type\": \"WIX_PAYMENTS\",\n \"amount\": \"10.00\",\n \"method\": \"offline\",\n \"providerTransactionId\": \"d9ef0f0c-e81a-4017-9d6a-977089eb411f\"\n }\n ],\n \"fulfillment\": {\n \"type\": \"DELIVERY\",\n \"promisedTime\": \"2021-04-22T11:20:52.171Z\",\n \"asap\": true,\n \"deliveryDetails\": {\n \"charge\": \"0.00\",\n \"address\": {\n \"formatted\": \"235 W 23rd St, New York, NY 10011, United States\",\n \"country\": null,\n \"city\": \"New York\",\n \"street\": \"West 23rd Street\",\n \"streetNumber\": \"235\",\n \"apt\": \"1\",\n \"floor\": \"3\",\n \"entrance\": null,\n \"zipCode\": \"10011-2302\",\n \"countryCode\": \"US\",\n \"onArrival\": \"UNSPECIFIED_ON_ARRIVAL_TYPE\",\n \"approximate\": false,\n \"comment\": null,\n \"location\": {\n \"latitude\": 40.7448484,\n \"longitude\": -73.9967498\n },\n \"addressLine2\": null\n }\n }\n },\n \"customer\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"phone\": \"2075556300\",\n \"email\": \"john@example.com\",\n \"contactId\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\"\n },\n \"totals\": {\n \"subtotal\": \"10.00\",\n \"total\": \"10.00\",\n \"delivery\": null,\n \"tax\": null,\n \"discount\": null,\n \"loyaltySavings\": null,\n \"quantity\": 1,\n \"tip\": null\n },\n \"activities\": [\n {\n \"timestamp\": \"2021-07-07T10:37:44.994Z\",\n \"message\": \"new\"\n },\n {\n \"timestamp\": \"2021-07-07T10:39:46.994Z\",\n \"message\": \"accepted []\"\n },\n {\n \"timestamp\": \"2021-07-07T10:50:55.994Z\",\n \"message\": \"fulfilled\"\n }\n ],\n \"channelInfo\": {\n \"type\": \"WEB\"\n },\n \"coupon\": null,\n \"loyaltyInfo\": null\n }\n}"}},{"name":"GetOrder","type":"METHOD","order":2,"content":{"title":"Get Order (Only order id and line items)","request":"curl -X GET\\\n 'https://www.wixapis.com/restaurants/v3/orders/64783425355' \\\n -H 'Authorization: ' \\\n -d '{\n \"fieldMask\": {\n \"paths\" : [\n \"id\",\n \"lineItems\"\n ]\n }\n }'","response":"{\n \"order\": {\n \"id\": \"64783425355\",\n \"createdDate\": null,\n \"updatedDate\": null,\n \"comment\": null,\n \"currency\": null,\n \"status\": \"UNSPECIFIED_ORDER_STATUS\",\n \"lineItems\": [\n {\n \"quantity\": 5,\n \"price\": \"2.00\",\n \"comment\": null,\n \"dishOptions\": [\n {\n \"name\": \"Taco Options\",\n \"minChoices\": 0,\n \"maxChoices\": 3,\n \"type\": \"EXTRAS\",\n \"availableChoices\": [\n {\n \"itemId\": \"2b5131cd-7872-4ee8-ae40-cb00c6dcaec1\",\n \"price\": \"1.00\"\n },\n {\n \"itemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"price\": \"1.50\"\n },\n {\n \"itemId\": \"0f3fee4d-1b4a-4cfd-9c79-11a52e8e4024\",\n \"price\": \"1.50\"\n }\n ],\n \"defaultChoices\": [],\n \"selectedChoices\": [\n {\n \"quantity\": 1,\n \"price\": \"1.50\",\n \"comment\": null,\n \"dishOptions\": [],\n \"catalogReference\": {\n \"catalogItemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"catalogItemName\": \"Fried Beans\",\n \"catalogItemDescription\": null,\n \"catalogItemMedia\": null\n }\n }\n ]\n }\n ],\n \"catalogReference\": {\n \"catalogItemId\": \"81cddf94-dcad-4f0e-9c3c-7556e3dbd4d8\",\n \"catalogItemName\": \"Chicken Taco\",\n \"catalogItemDescription\": \"with fresh veggies and Roasted Tomato Salsa\",\n \"catalogItemMedia\": \"https://static.wixstatic.com/media/11062bA4cabfdc2652413d92990cfac29777cc~mv2.jpg\"\n }\n }\n ],\n \"discounts\": [],\n \"payments\": [],\n \"fulfillment\": null,\n \"customer\": null,\n \"totals\": null,\n \"activities\": [],\n \"channelInfo\": null,\n \"coupon\": null,\n \"loyaltyInfo\": null\n }\n}"}},{"name":"GetOrder","type":"METHOD","order":1,"content":{"title":"Get Order with Field Masks","request":"curl -X GET\\\n 'https://www.wixapis.com/restaurants/v3/orders/64783425355' \\\n -H 'Authorization: ' \\\n -d '{\n \"fieldMask\": {\n \"paths\" : [\n \"id\",\n \"customer\"\n ]\n }\n }'","response":"{\n \"order\": {\n \"id\": \"64783425355\",\n \"createdDate\": null,\n \"updatedDate\": null,\n \"comment\": null,\n \"currency\": null,\n \"status\": \"UNSPECIFIED_ORDER_STATUS\",\n \"lineItems\": [],\n \"discounts\": [],\n \"payments\": [],\n \"fulfillment\": null,\n \"customer\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"phone\": \"2075556300\",\n \"email\": \"john@example.com\",\n \"contactId\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n },\n \"totals\": null,\n \"activities\": [],\n \"channelInfo\": null,\n \"coupon\": null,\n \"loyaltyInfo\": null\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","contentLink":{"displayName":"Get Order","slugifiedName":"get-order"}},{"summary":"List Orders","description":"Retrieves a list of up to 1000 orders, given the provided filters.","operationId":"com.wixpress.restaurants.orders.v3.OrdersApi.ListOrders","parameters":[{"name":"fieldMask","in":"query","description":"Set of fields to retrieve.\nFields that aren't included in `fieldmaks.paths` are ignored.\nSee [the article about field masks](https://dev.wix.com/api/rest/restaurants/orders/supported-field-masks)\nfor more details.","required":false,"schema":{"title":"fieldMask","description":"Set of fields to retrieve.\nFields that aren't included in `fieldmaks.paths` are ignored.\nSee [the article about field masks](https://dev.wix.com/api/rest/restaurants/orders/supported-field-masks)\nfor more details.","$ref":"#/components/schemas/google.protobuf.FieldMask","x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"status","in":"query","description":"Order status. Currently, it is not possible to filter by status `FULFILLED`.","required":false,"schema":{"title":"status","description":"Order status. Currently, it is not possible to filter by status `FULFILLED`.","type":"string","$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.Status","x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"createdDate","in":"query","description":"Order creation date and time. Must include a `gte:` or `lte:` prefix, for example: `gte:2021-10-26T12:48:15Z`.","required":false,"schema":{"title":"createdDate","description":"Order creation date and time. Must include a `gte:` or `lte:` prefix, for example: `gte:2021-10-26T12:48:15Z`.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"delivered","in":"query","description":"Whether the order has been delivered.","required":false,"schema":{"title":"delivered","description":"Whether the order has been delivered.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"locationIds","in":"query","description":"Location filter. Pass an array of location IDs to return orders with any of the provided locations.","required":false,"schema":{"title":"locationIds","description":"Location filter. Pass an array of location IDs to return orders with any of the provided locations.","format":"GUID","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"sort","in":"query","description":"Sorting options.","required":false,"schema":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.Sort","summary":"sort","description":"Sorting options.","x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"limit","in":"query","description":"Number of orders to return. The minimum limit is 1, the maximum 1000.","required":false,"schema":{"title":"limit","description":"Number of orders to return. The minimum limit is 1, the maximum 1000.","minimum":1,"maximum":1000,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.ListOrdersResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/restaurants/v3/orders","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/restaurants/v3/orders","destinationPath":"/v3/orders","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.restaurants.orders.v3.OrdersApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_RESTAURANTS.READ_ORDERS"],"externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-RESTAURANTS.MANAGE-ORDERS"},{"name":"Read Orders","scopeId":"SCOPE.DC-RESTAURANTS.READ-ORDERS"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Restaurants_MEGASCOPE","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.restaurants:restaurants-orders-webapp","serviceArtifactId":"com.wixpress.restaurants.restaurants-orders-webapp","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.restaurants.orders.v3.ListOrdersRequest","responseMessage":"com.wixpress.restaurants.orders.v3.ListOrdersResponse"},"legacyExamples":[{"name":"ListOrders","type":"METHOD","order":1,"content":{"title":"List Order with Field Masks","request":"curl -X GET \\\n 'https://www.wixapis.com/restaurants/v3/orders' \\\n -H 'Authorization: ' \\\n -d '{\n \"fieldMask\": {\n \"paths\" : [\n \"id\",\n \"customer\"\n ]\n }\n }'","response":"{\n \"orders\": [\n {\n \"id\": \"64783425355\",\n \"createdDate\": null,\n \"updatedDate\": null,\n \"comment\": null,\n \"currency\": null,\n \"status\": \"UNSPECIFIED_ORDER_STATUS\",\n \"lineItems\": [],\n \"discounts\": [],\n \"payments\": [],\n \"fulfillment\": null,\n \"customer\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"phone\": \"2075556300\",\n \"email\": \"john@example.com\",\n \"contactId\": \"9074ef3c-8686-4098-a5ab-c91cv4f44a58\",\n },\n \"totals\": null,\n \"activities\": [],\n \"channelInfo\": null,\n \"coupon\": null,\n \"loyaltyInfo\": null\n },\n {\n \"id\": \"759510479071\",\n \"createdDate\": null,\n \"updatedDate\": null,\n \"comment\": null,\n \"currency\": null,\n \"status\": \"UNSPECIFIED_ORDER_STATUS\",\n \"lineItems\": [],\n \"discounts\": [],\n \"payments\": [],\n \"fulfillment\": null,\n \"customer\": {\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"phone\": \"2315556426\",\n \"email\": \"janeSmith2@example.com\",\n \"contactId\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n },\n \"totals\": null,\n \"activities\": [],\n \"channelInfo\": null,\n \"coupon\": null,\n \"loyaltyInfo\": null\n }\n ]\n}"}},{"name":"ListOrders","type":"METHOD","content":{"title":"List Order, Sorted by creation date","request":"curl -X GET \\\n 'https://www.wixapis.com/restaurants/v3/orders' \\\n -H 'Authorization: ' \\\n -d '{\n \"sort\": {\n \"fieldName\": \"CREATED_DATE\",\n \"order\": \"DESC\"\n }\n }'","response":"{\n \"orders\": [\n {\n \"id\": \"64783425355\",\n \"createdDate\": \"2021-07-07T10:37:44.994Z\",\n \"updatedDate\": \"2021-07-07T10:39:46.994Z\",\n \"comment\": \"No peanuts please\",\n \"currency\": \"USD\",\n \"status\": \"ACCEPTED\",\n \"lineItems\": [\n {\n \"quantity\": 5,\n \"price\": \"2.00\",\n \"comment\": null,\n \"dishOptions\": [\n {\n \"name\": \"Taco Options\",\n \"minChoices\": 0,\n \"maxChoices\": 3,\n \"type\": \"EXTRAS\",\n \"availableChoices\": [\n {\n \"itemId\": \"2b5131cd-7872-4ee8-ae40-cb00c6dcaec1\",\n \"price\": \"1.00\"\n },\n {\n \"itemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"price\": \"1.50\"\n },\n {\n \"itemId\": \"0f3fee4d-1b4a-4cfd-9c79-11a52e8e4024\",\n \"price\": \"1.50\"\n }\n ],\n \"defaultChoices\": [],\n \"selectedChoices\": [\n {\n \"quantity\": 1,\n \"price\": \"1.50\",\n \"comment\": null,\n \"dishOptions\": [],\n \"catalogReference\": {\n \"catalogItemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"catalogItemName\": \"Fried Beans\",\n \"catalogItemDescription\": null,\n \"catalogItemMedia\": null\n }\n }\n ]\n }\n ],\n \"catalogReference\": {\n \"catalogItemId\": \"81cddf94-dcad-4f0e-9c3c-7556e3dbd4d8\",\n \"catalogItemName\": \"Chicken Taco\",\n \"catalogItemDescription\": \"with fresh veggies and Roasted Tomato Salsa\",\n \"catalogItemMedia\": \"https://static.wixstatic.com/media/11062bA4cabfdc2652413d92990cfac29777cc~mv2.jpg\"\n }\n }\n ],\n \"discounts\": [\n {\n \"appliedAmount\": \"15.00\",\n \"catalogDiscountType\": \"OFF_ORDER\",\n \"catalogDiscountName\": \"Sunday Order DIscount\"\n }\n ],\n \"payments\": [\n {\n \"type\": \"CASH\",\n \"amount\": \"10.00\",\n \"method\": \"offline\",\n \"providerTransactionId\": \"d9ef0f0c-e81a-4017-9d6a-977089eb411f\"\n }\n ],\n \"fulfillment\": {\n \"type\": \"DELIVERY\",\n \"promisedTime\": \"2021-07-07T11:17:44.994Z\",\n \"asap\": true,\n \"deliveryDetails\": {\n \"charge\": \"0.00\",\n \"address\": {\n \"formatted\": \"235 W 23rd St, New York, NY 10011, United States\",\n \"country\": null,\n \"city\": \"New York\",\n \"street\": \"West 23rd Street\",\n \"streetNumber\": \"235\",\n \"apt\": \"1\",\n \"floor\": \"3\",\n \"entrance\": null,\n \"zipCode\": \"10011-2302\",\n \"countryCode\": \"US\",\n \"onArrival\": \"UNSPECIFIED_ON_ARRIVAL_TYPE\",\n \"approximate\": false,\n \"comment\": null,\n \"location\": {\n \"latitude\": 40.7448484,\n \"longitude\": -73.9967498\n },\n \"addressLine2\": null\n }\n }\n },\n \"customer\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"phone\": \"2075556300\",\n \"email\": \"john@example.com\",\n \"contactId\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\"\n },\n \"totals\": {\n \"subtotal\": \"10.00\",\n \"total\": \"10.00\",\n \"delivery\": null,\n \"tax\": null,\n \"discount\": null,\n \"loyaltySavings\": null,\n \"quantity\": 1,\n \"tip\": null\n },\n \"activities\": [\n {\n \"timestamp\": \"2021-07-07T10:37:44.994Z\",\n \"message\": \"new\"\n },\n {\n \"timestamp\": \"2021-07-07T10:39:46.994Z\",\n \"message\": \"accepted []\"\n }\n ],\n \"channelInfo\": {\n \"type\": \"WEB\"\n },\n \"coupon\": null,\n \"loyaltyInfo\": null"}},{"name":"ListOrders","type":"METHOD","order":2,"content":{"title":"List Order (Only order id and line items)","request":"curl -X GET \\\n 'https://www.wixapis.com/restaurants/v3/orders' \\\n -H 'Authorization: ' \\\n -d '{\n \"fieldMask\": {\n \"paths\" : [\n \"id\",\n \"lineItems\"\n ]\n }\n }'","response":"{\n \"orders\": [\n {\n \"id\": \"759510479071\",\n \"createdDate\": null,\n \"updatedDate\": null,\n \"comment\": null,\n \"currency\": null,\n \"status\": \"UNSPECIFIED_ORDER_STATUS\",\n \"lineItems\": [\n {\n \"quantity\": 2,\n \"price\": \"6.00\",\n \"comment\": null,\n \"dishOptions\": [\n {\n \"name\": \"Taco Options\",\n \"minChoices\": 0,\n \"maxChoices\": 3,\n \"type\": \"EXTRAS\",\n \"availableChoices\": [\n {\n \"itemId\": \"2b5131cd-7872-4ee8-ae40-cb00c6dcaec1\",\n \"price\": \"1.00\"\n },\n {\n \"itemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"price\": \"1.50\"\n },\n {\n \"itemId\": \"0f3fee4d-1b4a-4cfd-9c79-11a52e8e4024\",\n \"price\": \"1.50\"\n }\n ],\n \"defaultChoices\": [],\n \"selectedChoices\": [\n {\n \"quantity\": 1,\n \"price\": \"1.50\",\n \"comment\": null,\n \"dishOptions\": [],\n \"catalogReference\": {\n \"catalogItemId\": \"0f3fee4d-1b4a-4cfd-9c79-11a52e8e4024\",\n \"catalogItemName\": \"Spanish Rice\",\n \"catalogItemDescription\": null,\n \"catalogItemMedia\": null\n }\n },\n {\n \"quantity\": 1,\n \"price\": \"1.50\",\n \"comment\": null,\n \"dishOptions\": [],\n \"catalogReference\": {\n \"catalogItemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"catalogItemName\": \"Fried Beans\",\n \"catalogItemDescription\": null,\n \"catalogItemMedia\": null\n }\n },\n {\n \"quantity\": 1,\n \"price\": \"1.00\",\n \"comment\": null,\n \"dishOptions\": [],\n \"catalogReference\": {\n \"catalogItemId\": \"2b5131cd-7872-4ee8-ae40-cb00c6dcaec1\",\n \"catalogItemName\": \"Avocado\",\n \"catalogItemDescription\": null,\n \"catalogItemMedia\": null\n }\n }\n ]\n }\n ],\n \"catalogReference\": {\n \"catalogItemId\": \"d6682658-c859-470c-9ef1-500969a486c9\",\n \"catalogItemName\": \"Chicken Burrito\",\n \"catalogItemDescription\": \"with rice, beans and lettuce\",\n \"catalogItemMedia\": \"https://static.wixstatic.com/media/11062bB944af5efcf44457b21a274f61a65316~mv2.jpg\"\n }\n }\n ],\n \"discounts\": [],\n \"payments\": [],\n \"fulfillment\": null,\n \"customer\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"phone\": \"2075556300\",\n \"email\": \"john@example.com\",\n \"contactId\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n },\n \"totals\": null,\n \"activities\": [],\n \"channelInfo\": null,\n \"coupon\": null,\n \"loyaltyInfo\": null\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"},"httpMethod":"get","path":"/v3/orders","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.restaurants.orders.v3.OrdersApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_RESTAURANTS.READ_ORDERS"],"externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-RESTAURANTS.MANAGE-ORDERS"},{"name":"Read Orders","scopeId":"SCOPE.DC-RESTAURANTS.READ-ORDERS"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Restaurants_MEGASCOPE","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.restaurants:restaurants-orders-webapp","serviceArtifactId":"com.wixpress.restaurants.restaurants-orders-webapp","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.restaurants.orders.v3.ListOrdersRequest","responseMessage":"com.wixpress.restaurants.orders.v3.ListOrdersResponse"},"legacyExamples":[{"name":"ListOrders","type":"METHOD","order":1,"content":{"title":"List Order with Field Masks","request":"curl -X GET \\\n 'https://www.wixapis.com/restaurants/v3/orders' \\\n -H 'Authorization: ' \\\n -d '{\n \"fieldMask\": {\n \"paths\" : [\n \"id\",\n \"customer\"\n ]\n }\n }'","response":"{\n \"orders\": [\n {\n \"id\": \"64783425355\",\n \"createdDate\": null,\n \"updatedDate\": null,\n \"comment\": null,\n \"currency\": null,\n \"status\": \"UNSPECIFIED_ORDER_STATUS\",\n \"lineItems\": [],\n \"discounts\": [],\n \"payments\": [],\n \"fulfillment\": null,\n \"customer\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"phone\": \"2075556300\",\n \"email\": \"john@example.com\",\n \"contactId\": \"9074ef3c-8686-4098-a5ab-c91cv4f44a58\",\n },\n \"totals\": null,\n \"activities\": [],\n \"channelInfo\": null,\n \"coupon\": null,\n \"loyaltyInfo\": null\n },\n {\n \"id\": \"759510479071\",\n \"createdDate\": null,\n \"updatedDate\": null,\n \"comment\": null,\n \"currency\": null,\n \"status\": \"UNSPECIFIED_ORDER_STATUS\",\n \"lineItems\": [],\n \"discounts\": [],\n \"payments\": [],\n \"fulfillment\": null,\n \"customer\": {\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"phone\": \"2315556426\",\n \"email\": \"janeSmith2@example.com\",\n \"contactId\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n },\n \"totals\": null,\n \"activities\": [],\n \"channelInfo\": null,\n \"coupon\": null,\n \"loyaltyInfo\": null\n }\n ]\n}"}},{"name":"ListOrders","type":"METHOD","content":{"title":"List Order, Sorted by creation date","request":"curl -X GET \\\n 'https://www.wixapis.com/restaurants/v3/orders' \\\n -H 'Authorization: ' \\\n -d '{\n \"sort\": {\n \"fieldName\": \"CREATED_DATE\",\n \"order\": \"DESC\"\n }\n }'","response":"{\n \"orders\": [\n {\n \"id\": \"64783425355\",\n \"createdDate\": \"2021-07-07T10:37:44.994Z\",\n \"updatedDate\": \"2021-07-07T10:39:46.994Z\",\n \"comment\": \"No peanuts please\",\n \"currency\": \"USD\",\n \"status\": \"ACCEPTED\",\n \"lineItems\": [\n {\n \"quantity\": 5,\n \"price\": \"2.00\",\n \"comment\": null,\n \"dishOptions\": [\n {\n \"name\": \"Taco Options\",\n \"minChoices\": 0,\n \"maxChoices\": 3,\n \"type\": \"EXTRAS\",\n \"availableChoices\": [\n {\n \"itemId\": \"2b5131cd-7872-4ee8-ae40-cb00c6dcaec1\",\n \"price\": \"1.00\"\n },\n {\n \"itemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"price\": \"1.50\"\n },\n {\n \"itemId\": \"0f3fee4d-1b4a-4cfd-9c79-11a52e8e4024\",\n \"price\": \"1.50\"\n }\n ],\n \"defaultChoices\": [],\n \"selectedChoices\": [\n {\n \"quantity\": 1,\n \"price\": \"1.50\",\n \"comment\": null,\n \"dishOptions\": [],\n \"catalogReference\": {\n \"catalogItemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"catalogItemName\": \"Fried Beans\",\n \"catalogItemDescription\": null,\n \"catalogItemMedia\": null\n }\n }\n ]\n }\n ],\n \"catalogReference\": {\n \"catalogItemId\": \"81cddf94-dcad-4f0e-9c3c-7556e3dbd4d8\",\n \"catalogItemName\": \"Chicken Taco\",\n \"catalogItemDescription\": \"with fresh veggies and Roasted Tomato Salsa\",\n \"catalogItemMedia\": \"https://static.wixstatic.com/media/11062bA4cabfdc2652413d92990cfac29777cc~mv2.jpg\"\n }\n }\n ],\n \"discounts\": [\n {\n \"appliedAmount\": \"15.00\",\n \"catalogDiscountType\": \"OFF_ORDER\",\n \"catalogDiscountName\": \"Sunday Order DIscount\"\n }\n ],\n \"payments\": [\n {\n \"type\": \"CASH\",\n \"amount\": \"10.00\",\n \"method\": \"offline\",\n \"providerTransactionId\": \"d9ef0f0c-e81a-4017-9d6a-977089eb411f\"\n }\n ],\n \"fulfillment\": {\n \"type\": \"DELIVERY\",\n \"promisedTime\": \"2021-07-07T11:17:44.994Z\",\n \"asap\": true,\n \"deliveryDetails\": {\n \"charge\": \"0.00\",\n \"address\": {\n \"formatted\": \"235 W 23rd St, New York, NY 10011, United States\",\n \"country\": null,\n \"city\": \"New York\",\n \"street\": \"West 23rd Street\",\n \"streetNumber\": \"235\",\n \"apt\": \"1\",\n \"floor\": \"3\",\n \"entrance\": null,\n \"zipCode\": \"10011-2302\",\n \"countryCode\": \"US\",\n \"onArrival\": \"UNSPECIFIED_ON_ARRIVAL_TYPE\",\n \"approximate\": false,\n \"comment\": null,\n \"location\": {\n \"latitude\": 40.7448484,\n \"longitude\": -73.9967498\n },\n \"addressLine2\": null\n }\n }\n },\n \"customer\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"phone\": \"2075556300\",\n \"email\": \"john@example.com\",\n \"contactId\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\"\n },\n \"totals\": {\n \"subtotal\": \"10.00\",\n \"total\": \"10.00\",\n \"delivery\": null,\n \"tax\": null,\n \"discount\": null,\n \"loyaltySavings\": null,\n \"quantity\": 1,\n \"tip\": null\n },\n \"activities\": [\n {\n \"timestamp\": \"2021-07-07T10:37:44.994Z\",\n \"message\": \"new\"\n },\n {\n \"timestamp\": \"2021-07-07T10:39:46.994Z\",\n \"message\": \"accepted []\"\n }\n ],\n \"channelInfo\": {\n \"type\": \"WEB\"\n },\n \"coupon\": null,\n \"loyaltyInfo\": null"}},{"name":"ListOrders","type":"METHOD","order":2,"content":{"title":"List Order (Only order id and line items)","request":"curl -X GET \\\n 'https://www.wixapis.com/restaurants/v3/orders' \\\n -H 'Authorization: ' \\\n -d '{\n \"fieldMask\": {\n \"paths\" : [\n \"id\",\n \"lineItems\"\n ]\n }\n }'","response":"{\n \"orders\": [\n {\n \"id\": \"759510479071\",\n \"createdDate\": null,\n \"updatedDate\": null,\n \"comment\": null,\n \"currency\": null,\n \"status\": \"UNSPECIFIED_ORDER_STATUS\",\n \"lineItems\": [\n {\n \"quantity\": 2,\n \"price\": \"6.00\",\n \"comment\": null,\n \"dishOptions\": [\n {\n \"name\": \"Taco Options\",\n \"minChoices\": 0,\n \"maxChoices\": 3,\n \"type\": \"EXTRAS\",\n \"availableChoices\": [\n {\n \"itemId\": \"2b5131cd-7872-4ee8-ae40-cb00c6dcaec1\",\n \"price\": \"1.00\"\n },\n {\n \"itemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"price\": \"1.50\"\n },\n {\n \"itemId\": \"0f3fee4d-1b4a-4cfd-9c79-11a52e8e4024\",\n \"price\": \"1.50\"\n }\n ],\n \"defaultChoices\": [],\n \"selectedChoices\": [\n {\n \"quantity\": 1,\n \"price\": \"1.50\",\n \"comment\": null,\n \"dishOptions\": [],\n \"catalogReference\": {\n \"catalogItemId\": \"0f3fee4d-1b4a-4cfd-9c79-11a52e8e4024\",\n \"catalogItemName\": \"Spanish Rice\",\n \"catalogItemDescription\": null,\n \"catalogItemMedia\": null\n }\n },\n {\n \"quantity\": 1,\n \"price\": \"1.50\",\n \"comment\": null,\n \"dishOptions\": [],\n \"catalogReference\": {\n \"catalogItemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"catalogItemName\": \"Fried Beans\",\n \"catalogItemDescription\": null,\n \"catalogItemMedia\": null\n }\n },\n {\n \"quantity\": 1,\n \"price\": \"1.00\",\n \"comment\": null,\n \"dishOptions\": [],\n \"catalogReference\": {\n \"catalogItemId\": \"2b5131cd-7872-4ee8-ae40-cb00c6dcaec1\",\n \"catalogItemName\": \"Avocado\",\n \"catalogItemDescription\": null,\n \"catalogItemMedia\": null\n }\n }\n ]\n }\n ],\n \"catalogReference\": {\n \"catalogItemId\": \"d6682658-c859-470c-9ef1-500969a486c9\",\n \"catalogItemName\": \"Chicken Burrito\",\n \"catalogItemDescription\": \"with rice, beans and lettuce\",\n \"catalogItemMedia\": \"https://static.wixstatic.com/media/11062bB944af5efcf44457b21a274f61a65316~mv2.jpg\"\n }\n }\n ],\n \"discounts\": [],\n \"payments\": [],\n \"fulfillment\": null,\n \"customer\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"phone\": \"2075556300\",\n \"email\": \"john@example.com\",\n \"contactId\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n },\n \"totals\": null,\n \"activities\": [],\n \"channelInfo\": null,\n \"coupon\": null,\n \"loyaltyInfo\": null\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","contentLink":{"displayName":"List Orders","slugifiedName":"list-orders"}},{"summary":"Accept Order","description":"Changes the order status to `ACCEPTED`.\n\n> **Note:** It is not possible to change the order status from `FULFILLED` to `ACCEPTED`.","operationId":"com.wixpress.restaurants.orders.v3.OrdersApi.AcceptOrder","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"ID of the order to mark as `ACCEPTED`.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.AcceptOrderResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/restaurants/v3/orders","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/restaurants/v3/orders","destinationPath":"/v3/orders","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"AcceptOrderRequest","description":"","properties":{"message":{"title":"message","description":"Message when accepting the order.","maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"oneOf":[{"description":"","summary":"deliveryTime","$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.AcceptOrderRequest.deliveryTime"}],"required":["id"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Order Accepted","description":"Triggered when an order is accepted.","permissions":["WIX_RESTAURANTS.READ_ORDERS"],"payload":{"schemaName":"com.wixpress.restaurants.orders.v3.OrderAccepted"},"exposure":"PUBLIC","maturity":"BETA","slug":"accepted","eventTopic":"domain_events_wix.restaurants.v3.order","serviceName":"com.wixpress.restaurants.orders.v3.OrdersApi","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"}],"serviceName":"com.wixpress.restaurants.orders.v3.OrdersApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_RESTAURANTS.MANAGE_ORDERS"],"externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-RESTAURANTS.MANAGE-ORDERS"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Restaurants_MEGASCOPE","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.restaurants:restaurants-orders-webapp","serviceArtifactId":"com.wixpress.restaurants.restaurants-orders-webapp","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.restaurants.orders.v3.AcceptOrderRequest","responseMessage":"com.wixpress.restaurants.orders.v3.AcceptOrderResponse"},"legacyExamples":[{"name":"AcceptOrder","type":"METHOD","content":{"title":"Accept Order","request":"curl -X POST \\\n 'https://www.wixapis.com/restaurants/v3/orders/64783425355/accept' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"message\": \"Accept order\"\n }'","response":"{\n \"order\": {\n \"id\": \"64783425355\",\n \"createdDate\": \"2021-07-07T10:37:44.994Z\",\n \"updatedDate\": \"2021-07-07T10:39:46.994Z\",\n \"comment\": \"No peanuts please\",\n \"currency\": \"USD\",\n \"status\": \"ACCEPTED\",\n \"lineItems\": [\n {\n \"quantity\": 5,\n \"price\": \"2.00\",\n \"comment\": null,\n \"dishOptions\": [\n {\n \"name\": \"Taco Options\",\n \"minChoices\": 0,\n \"maxChoices\": 3,\n \"type\": \"EXTRAS\",\n \"availableChoices\": [\n {\n \"itemId\": \"2b5131cd-7872-4ee8-ae40-cb00c6dcaec1\",\n \"price\": \"1.00\"\n },\n {\n \"itemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"price\": \"1.50\"\n },\n {\n \"itemId\": \"0f3fee4d-1b4a-4cfd-9c79-11a52e8e4024\",\n \"price\": \"1.50\"\n }\n ],\n \"defaultChoices\": [],\n \"selectedChoices\": [\n {\n \"quantity\": 1,\n \"price\": \"1.50\",\n \"comment\": null,\n \"catalogReference\": {\n \"catalogItemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"catalogItemName\": \"Fried Beans\",\n \"catalogItemDescription\": null,\n \"catalogItemMedia\": null\n }\n }\n ]\n }\n ],\n \"catalogReference\": {\n \"catalogItemId\": \"81cddf94-dcad-4f0e-9c3c-7556e3dbd4d8\",\n \"catalogItemName\": \"Chicken Taco\",\n \"catalogItemDescription\": \"with fresh veggies and Roasted Tomato Salsa\",\n \"catalogItemMedia\": \"https://static.wixstatic.com/media/11062bA4cabfdc2652413d92990cfac29777cc~mv2.jpg\"\n }\n }\n ],\n \"discounts\": [\n {\n \"catalogDiscountId\": \"bc697347-c180-494b-b68d-bc63ac63a84b\",\n \"appliedAmount\": \"15.00\",\n \"catalogDiscountType\": \"OFF_ORDER\",\n \"catalogDiscountName\": \"Sunday Order Discount\"\n }\n ],\n \"payments\": [\n {\n \"type\": \"CASH\",\n \"amount\": \"10.00\",\n \"method\": \"offline\",\n \"providerTransactionId\": \"d9ef0f0c-e81a-4017-9d6a-977089eb411f\"\n }\n ],\n \"fulfillment\": {\n \"type\": \"DELIVERY\",\n \"promisedTime\": \"2021-07-07T11:17:44.994Z\",\n \"asap\": true,\n \"deliveryDetails\": {\n \"charge\": \"0.00\",\n \"address\": {\n \"formatted\": \"235 W 23rd St, New York, NY 10011, United States\",\n \"country\": null,\n \"city\": \"New York\",\n \"street\": \"West 23rd Street\",\n \"streetNumber\": \"235\",\n \"apt\": \"1\",\n \"floor\": \"3\",\n \"entrance\": null,\n \"zipCode\": \"10011-2302\",\n \"countryCode\": \"US\",\n \"onArrival\": \"UNSPECIFIED_ON_ARRIVAL_TYPE\",\n \"approximate\": false,\n \"comment\": null,\n \"location\": {\n \"latitude\": 40.7448484,\n \"longitude\": -73.9967498\n },\n \"addressLine2\": null\n }\n }\n },\n \"customer\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"phone\": \"2075556300\",\n \"email\": \"john@example.com\",\n \"contactId\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\"\n },\n \"totals\": {\n \"subtotal\": \"10.00\",\n \"total\": \"10.00\",\n \"delivery\": null,\n \"tax\": null,\n \"discount\": null,\n \"loyaltySavings\": null,\n \"quantity\": 1,\n \"tip\": null\n },\n \"activities\": [\n {\n \"timestamp\": \"2021-07-07T10:37:44.994Z\",\n \"message\": \"new\"\n },\n {\n \"timestamp\": \"2021-07-07T10:39:46.994Z\",\n \"message\": \"accepted [Accept order]\"\n }\n ],\n \"channelInfo\": {\n \"type\": \"WEB\"\n },\n \"coupon\": null,\n \"loyaltyInfo\": null\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"},"httpMethod":"post","path":"/v3/orders/{id}/accept","rpcOnly":false,"triggeredEvents":[{"title":"Order Accepted","description":"Triggered when an order is accepted.","permissions":["WIX_RESTAURANTS.READ_ORDERS"],"payload":{"schemaName":"com.wixpress.restaurants.orders.v3.OrderAccepted"},"exposure":"PUBLIC","maturity":"BETA","slug":"accepted","eventTopic":"domain_events_wix.restaurants.v3.order","serviceName":"com.wixpress.restaurants.orders.v3.OrdersApi","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"}],"serviceName":"com.wixpress.restaurants.orders.v3.OrdersApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_RESTAURANTS.MANAGE_ORDERS"],"externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-RESTAURANTS.MANAGE-ORDERS"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Restaurants_MEGASCOPE","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.restaurants:restaurants-orders-webapp","serviceArtifactId":"com.wixpress.restaurants.restaurants-orders-webapp","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.restaurants.orders.v3.AcceptOrderRequest","responseMessage":"com.wixpress.restaurants.orders.v3.AcceptOrderResponse"},"legacyExamples":[{"name":"AcceptOrder","type":"METHOD","content":{"title":"Accept Order","request":"curl -X POST \\\n 'https://www.wixapis.com/restaurants/v3/orders/64783425355/accept' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"message\": \"Accept order\"\n }'","response":"{\n \"order\": {\n \"id\": \"64783425355\",\n \"createdDate\": \"2021-07-07T10:37:44.994Z\",\n \"updatedDate\": \"2021-07-07T10:39:46.994Z\",\n \"comment\": \"No peanuts please\",\n \"currency\": \"USD\",\n \"status\": \"ACCEPTED\",\n \"lineItems\": [\n {\n \"quantity\": 5,\n \"price\": \"2.00\",\n \"comment\": null,\n \"dishOptions\": [\n {\n \"name\": \"Taco Options\",\n \"minChoices\": 0,\n \"maxChoices\": 3,\n \"type\": \"EXTRAS\",\n \"availableChoices\": [\n {\n \"itemId\": \"2b5131cd-7872-4ee8-ae40-cb00c6dcaec1\",\n \"price\": \"1.00\"\n },\n {\n \"itemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"price\": \"1.50\"\n },\n {\n \"itemId\": \"0f3fee4d-1b4a-4cfd-9c79-11a52e8e4024\",\n \"price\": \"1.50\"\n }\n ],\n \"defaultChoices\": [],\n \"selectedChoices\": [\n {\n \"quantity\": 1,\n \"price\": \"1.50\",\n \"comment\": null,\n \"catalogReference\": {\n \"catalogItemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"catalogItemName\": \"Fried Beans\",\n \"catalogItemDescription\": null,\n \"catalogItemMedia\": null\n }\n }\n ]\n }\n ],\n \"catalogReference\": {\n \"catalogItemId\": \"81cddf94-dcad-4f0e-9c3c-7556e3dbd4d8\",\n \"catalogItemName\": \"Chicken Taco\",\n \"catalogItemDescription\": \"with fresh veggies and Roasted Tomato Salsa\",\n \"catalogItemMedia\": \"https://static.wixstatic.com/media/11062bA4cabfdc2652413d92990cfac29777cc~mv2.jpg\"\n }\n }\n ],\n \"discounts\": [\n {\n \"catalogDiscountId\": \"bc697347-c180-494b-b68d-bc63ac63a84b\",\n \"appliedAmount\": \"15.00\",\n \"catalogDiscountType\": \"OFF_ORDER\",\n \"catalogDiscountName\": \"Sunday Order Discount\"\n }\n ],\n \"payments\": [\n {\n \"type\": \"CASH\",\n \"amount\": \"10.00\",\n \"method\": \"offline\",\n \"providerTransactionId\": \"d9ef0f0c-e81a-4017-9d6a-977089eb411f\"\n }\n ],\n \"fulfillment\": {\n \"type\": \"DELIVERY\",\n \"promisedTime\": \"2021-07-07T11:17:44.994Z\",\n \"asap\": true,\n \"deliveryDetails\": {\n \"charge\": \"0.00\",\n \"address\": {\n \"formatted\": \"235 W 23rd St, New York, NY 10011, United States\",\n \"country\": null,\n \"city\": \"New York\",\n \"street\": \"West 23rd Street\",\n \"streetNumber\": \"235\",\n \"apt\": \"1\",\n \"floor\": \"3\",\n \"entrance\": null,\n \"zipCode\": \"10011-2302\",\n \"countryCode\": \"US\",\n \"onArrival\": \"UNSPECIFIED_ON_ARRIVAL_TYPE\",\n \"approximate\": false,\n \"comment\": null,\n \"location\": {\n \"latitude\": 40.7448484,\n \"longitude\": -73.9967498\n },\n \"addressLine2\": null\n }\n }\n },\n \"customer\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"phone\": \"2075556300\",\n \"email\": \"john@example.com\",\n \"contactId\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\"\n },\n \"totals\": {\n \"subtotal\": \"10.00\",\n \"total\": \"10.00\",\n \"delivery\": null,\n \"tax\": null,\n \"discount\": null,\n \"loyaltySavings\": null,\n \"quantity\": 1,\n \"tip\": null\n },\n \"activities\": [\n {\n \"timestamp\": \"2021-07-07T10:37:44.994Z\",\n \"message\": \"new\"\n },\n {\n \"timestamp\": \"2021-07-07T10:39:46.994Z\",\n \"message\": \"accepted [Accept order]\"\n }\n ],\n \"channelInfo\": {\n \"type\": \"WEB\"\n },\n \"coupon\": null,\n \"loyaltyInfo\": null\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","contentLink":{"displayName":"Accept Order","slugifiedName":"accept-order"}},{"summary":"Cancel Order","description":"Changes the order status to `CANCELED`.","operationId":"com.wixpress.restaurants.orders.v3.OrdersApi.CancelOrder","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"ID of the order to mark as `CANCELED`.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.CancelOrderResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/restaurants/v3/orders","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/restaurants/v3/orders","destinationPath":"/v3/orders","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CancelOrderRequest","description":"","properties":{"message":{"title":"message","description":"Message when canceling the order.","maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["id"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Order Canceled","description":"Triggered when an order is canceled.","permissions":["WIX_RESTAURANTS.READ_ORDERS"],"payload":{"schemaName":"com.wixpress.restaurants.orders.v3.OrderCanceled"},"exposure":"PUBLIC","maturity":"BETA","slug":"canceled","eventTopic":"domain_events_wix.restaurants.v3.order","serviceName":"com.wixpress.restaurants.orders.v3.OrdersApi","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"}],"serviceName":"com.wixpress.restaurants.orders.v3.OrdersApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_RESTAURANTS.MANAGE_ORDERS"],"externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-RESTAURANTS.MANAGE-ORDERS"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Restaurants_MEGASCOPE","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.restaurants:restaurants-orders-webapp","serviceArtifactId":"com.wixpress.restaurants.restaurants-orders-webapp","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.restaurants.orders.v3.CancelOrderRequest","responseMessage":"com.wixpress.restaurants.orders.v3.CancelOrderResponse"},"legacyExamples":[{"name":"CancelOrder","type":"METHOD","content":{"title":"Cancel Order","request":"curl -X POST \\\n 'https://www.wixapis.com/restaurants/v3/orders/64783425355/cancel' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"message\": \"Ordered wrong dish\"\n }'","response":"{\n \"order\": {\n \"id\": \"64783425355\",\n \"createdDate\": \"2021-07-22T12:35:51.675Z\",\n \"updatedDate\": \"2021-07-07T10:39:46.994Z\",\n \"comment\": \"no need for cutlery\",\n \"currency\": \"USD\",\n \"status\": \"CANCELED\",\n \"lineItems\": [\n {\n \"quantity\": 5,\n \"price\": \"2.00\",\n \"comment\": null,\n \"dishOptions\": [\n {\n \"name\": \"Taco Options\",\n \"minChoices\": 0,\n \"maxChoices\": 3,\n \"type\": \"EXTRAS\",\n \"availableChoices\": [\n {\n \"itemId\": \"2b5131cd-7872-4ee8-ae40-cb00c6dcaec1\",\n \"price\": \"1.00\"\n },\n {\n \"itemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"price\": \"1.50\"\n },\n {\n \"itemId\": \"0f3fee4d-1b4a-4cfd-9c79-11a52e8e4024\",\n \"price\": \"1.50\"\n }\n ],\n \"defaultChoices\": [],\n \"selectedChoices\": [\n {\n \"quantity\": 1,\n \"price\": \"1.50\",\n \"comment\": null,\n \"dishOptions\": [],\n \"catalogReference\": {\n \"catalogItemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"catalogItemName\": \"Fried Beans\",\n \"catalogItemDescription\": null,\n \"catalogItemMedia\": null\n }\n }\n ],\n }\n ],\n \"catalogReference\": {\n \"catalogItemId\": \"81cddf94-dcad-4f0e-9c3c-7556e3dbd4d8\",\n \"catalogItemName\": \"Chicken Taco\",\n \"catalogItemDescription\": \"with fresh veggies and Roasted Tomato Salsa\",\n \"catalogItemMedia\": \"https://static.wixstatic.com/media/11062bA4cabfdc2652413d92990cfac29777cc~mv2.jpg\"\n }\n }\n ],\n \"discounts\": [\n {\n \"catalogDiscountId\": \"bc697347-c180-494b-b68d-bc63ac63a84b\",\n \"appliedAmount\": \"15.00\",\n \"catalogDiscountType\": \"OFF_ORDER\",\n \"catalogDiscountName\": \"Sunday Order Discount\"\n }\n ],\n \"payments\": [\n {\n \"type\": \"WIX_PAYMENTS\",\n \"amount\": \"10.00\",\n \"method\": \"offline\",\n \"providerTransactionId\": \"d9ef0f0c-e81a-4017-9d6a-977089eb411f\"\n }\n ],\n \"fulfillment\": {\n \"type\": \"DELIVERY\",\n \"promisedTime\": \"2021-04-22T11:20:52.171Z\",\n \"asap\": true,\n \"deliveryDetails\": {\n \"charge\": \"0.00\",\n \"address\": {\n \"formatted\": \"235 W 23rd St, New York, NY 10011, United States\",\n \"country\": null,\n \"city\": \"New York\",\n \"street\": \"West 23rd Street\",\n \"streetNumber\": \"235\",\n \"apt\": \"1\",\n \"floor\": \"3\",\n \"entrance\": null,\n \"zipCode\": \"10011-2302\",\n \"countryCode\": \"US\",\n \"onArrival\": \"UNSPECIFIED_ON_ARRIVAL_TYPE\",\n \"approximate\": false,\n \"comment\": null,\n \"location\": {\n \"latitude\": 40.7448484,\n \"longitude\": -73.9967498\n },\n \"addressLine2\": null\n }\n }\n },\n \"customer\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"phone\": \"2075556300\",\n \"email\": \"john@example.com\",\n \"contactId\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\"\n },\n \"totals\": {\n \"subtotal\": \"10.00\",\n \"total\": \"10.00\",\n \"delivery\": null,\n \"tax\": null,\n \"discount\": null,\n \"loyaltySavings\": null,\n \"quantity\": 1,\n \"tip\": null\n },\n \"activities\": [\n {\n \"timestamp\": \"2021-07-07T10:37:44.994Z\",\n \"message\": \"new\"\n },\n {\n \"timestamp\": \"2021-07-07T10:39:46.994Z\",\n \"message\": \"canceled [ordered wrong dish]\"\n }\n ],\n \"channelInfo\": {\n \"type\": \"WEB\"\n },\n \"coupon\": null,\n \"loyaltyInfo\": null\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"},"httpMethod":"post","path":"/v3/orders/{id}/cancel","rpcOnly":false,"triggeredEvents":[{"title":"Order Canceled","description":"Triggered when an order is canceled.","permissions":["WIX_RESTAURANTS.READ_ORDERS"],"payload":{"schemaName":"com.wixpress.restaurants.orders.v3.OrderCanceled"},"exposure":"PUBLIC","maturity":"BETA","slug":"canceled","eventTopic":"domain_events_wix.restaurants.v3.order","serviceName":"com.wixpress.restaurants.orders.v3.OrdersApi","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"}],"serviceName":"com.wixpress.restaurants.orders.v3.OrdersApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_RESTAURANTS.MANAGE_ORDERS"],"externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-RESTAURANTS.MANAGE-ORDERS"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Restaurants_MEGASCOPE","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.restaurants:restaurants-orders-webapp","serviceArtifactId":"com.wixpress.restaurants.restaurants-orders-webapp","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.restaurants.orders.v3.CancelOrderRequest","responseMessage":"com.wixpress.restaurants.orders.v3.CancelOrderResponse"},"legacyExamples":[{"name":"CancelOrder","type":"METHOD","content":{"title":"Cancel Order","request":"curl -X POST \\\n 'https://www.wixapis.com/restaurants/v3/orders/64783425355/cancel' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"message\": \"Ordered wrong dish\"\n }'","response":"{\n \"order\": {\n \"id\": \"64783425355\",\n \"createdDate\": \"2021-07-22T12:35:51.675Z\",\n \"updatedDate\": \"2021-07-07T10:39:46.994Z\",\n \"comment\": \"no need for cutlery\",\n \"currency\": \"USD\",\n \"status\": \"CANCELED\",\n \"lineItems\": [\n {\n \"quantity\": 5,\n \"price\": \"2.00\",\n \"comment\": null,\n \"dishOptions\": [\n {\n \"name\": \"Taco Options\",\n \"minChoices\": 0,\n \"maxChoices\": 3,\n \"type\": \"EXTRAS\",\n \"availableChoices\": [\n {\n \"itemId\": \"2b5131cd-7872-4ee8-ae40-cb00c6dcaec1\",\n \"price\": \"1.00\"\n },\n {\n \"itemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"price\": \"1.50\"\n },\n {\n \"itemId\": \"0f3fee4d-1b4a-4cfd-9c79-11a52e8e4024\",\n \"price\": \"1.50\"\n }\n ],\n \"defaultChoices\": [],\n \"selectedChoices\": [\n {\n \"quantity\": 1,\n \"price\": \"1.50\",\n \"comment\": null,\n \"dishOptions\": [],\n \"catalogReference\": {\n \"catalogItemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"catalogItemName\": \"Fried Beans\",\n \"catalogItemDescription\": null,\n \"catalogItemMedia\": null\n }\n }\n ],\n }\n ],\n \"catalogReference\": {\n \"catalogItemId\": \"81cddf94-dcad-4f0e-9c3c-7556e3dbd4d8\",\n \"catalogItemName\": \"Chicken Taco\",\n \"catalogItemDescription\": \"with fresh veggies and Roasted Tomato Salsa\",\n \"catalogItemMedia\": \"https://static.wixstatic.com/media/11062bA4cabfdc2652413d92990cfac29777cc~mv2.jpg\"\n }\n }\n ],\n \"discounts\": [\n {\n \"catalogDiscountId\": \"bc697347-c180-494b-b68d-bc63ac63a84b\",\n \"appliedAmount\": \"15.00\",\n \"catalogDiscountType\": \"OFF_ORDER\",\n \"catalogDiscountName\": \"Sunday Order Discount\"\n }\n ],\n \"payments\": [\n {\n \"type\": \"WIX_PAYMENTS\",\n \"amount\": \"10.00\",\n \"method\": \"offline\",\n \"providerTransactionId\": \"d9ef0f0c-e81a-4017-9d6a-977089eb411f\"\n }\n ],\n \"fulfillment\": {\n \"type\": \"DELIVERY\",\n \"promisedTime\": \"2021-04-22T11:20:52.171Z\",\n \"asap\": true,\n \"deliveryDetails\": {\n \"charge\": \"0.00\",\n \"address\": {\n \"formatted\": \"235 W 23rd St, New York, NY 10011, United States\",\n \"country\": null,\n \"city\": \"New York\",\n \"street\": \"West 23rd Street\",\n \"streetNumber\": \"235\",\n \"apt\": \"1\",\n \"floor\": \"3\",\n \"entrance\": null,\n \"zipCode\": \"10011-2302\",\n \"countryCode\": \"US\",\n \"onArrival\": \"UNSPECIFIED_ON_ARRIVAL_TYPE\",\n \"approximate\": false,\n \"comment\": null,\n \"location\": {\n \"latitude\": 40.7448484,\n \"longitude\": -73.9967498\n },\n \"addressLine2\": null\n }\n }\n },\n \"customer\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"phone\": \"2075556300\",\n \"email\": \"john@example.com\",\n \"contactId\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\"\n },\n \"totals\": {\n \"subtotal\": \"10.00\",\n \"total\": \"10.00\",\n \"delivery\": null,\n \"tax\": null,\n \"discount\": null,\n \"loyaltySavings\": null,\n \"quantity\": 1,\n \"tip\": null\n },\n \"activities\": [\n {\n \"timestamp\": \"2021-07-07T10:37:44.994Z\",\n \"message\": \"new\"\n },\n {\n \"timestamp\": \"2021-07-07T10:39:46.994Z\",\n \"message\": \"canceled [ordered wrong dish]\"\n }\n ],\n \"channelInfo\": {\n \"type\": \"WEB\"\n },\n \"coupon\": null,\n \"loyaltyInfo\": null\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","contentLink":{"displayName":"Cancel Order","slugifiedName":"cancel-order"}},{"summary":"Fulfill Order","description":"Changes the order status to `FULFILLED`.","operationId":"com.wixpress.restaurants.orders.v3.OrdersApi.FulfillOrder","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"ID of the order to mark as `FULFILLED`.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.FulfillOrderResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/restaurants/v3/orders","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/restaurants/v3/orders","destinationPath":"/v3/orders","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"FulfillOrderRequest","description":"","properties":{},"deprecated":false,"required":["id"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Order Fulfilled","description":"Triggered when an order is fulfilled.","permissions":["WIX_RESTAURANTS.READ_ORDERS"],"payload":{"schemaName":"com.wixpress.restaurants.orders.v3.OrderFulfilled"},"exposure":"PUBLIC","maturity":"BETA","slug":"fulfilled","eventTopic":"domain_events_wix.restaurants.v3.order","serviceName":"com.wixpress.restaurants.orders.v3.OrdersApi","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"}],"serviceName":"com.wixpress.restaurants.orders.v3.OrdersApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_RESTAURANTS.MANAGE_ORDERS"],"externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-RESTAURANTS.MANAGE-ORDERS"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Restaurants_MEGASCOPE","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.restaurants:restaurants-orders-webapp","serviceArtifactId":"com.wixpress.restaurants.restaurants-orders-webapp","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.restaurants.orders.v3.FulfillOrderRequest","responseMessage":"com.wixpress.restaurants.orders.v3.FulfillOrderResponse"},"legacyExamples":[{"name":"FulfillOrder","type":"METHOD","content":{"title":"Fulfill Order","request":"curl -X POST \\\n 'https://www.wixapis.com/restaurants/v3/orders/64783425355/fulfill' \\\n -H 'Authorization: '","response":"{\n \"order\": {\n \"id\": \"64783425355\",\n \"createdDate\": \"2021-07-22T12:35:51.675Z\",\n \"updatedDate\": \"2021-07-07T12:37:44.994Z\",\n \"comment\": \"call when arriving to building\",\n \"currency\": \"USD\",\n \"status\": \"FULFILLED\",\n \"lineItems\": [\n {\n \"quantity\": 3,\n \"price\": \"2.00\",\n \"comment\": null,\n \"dishOptions\": [\n {\n \"name\": \"Taco Options\",\n \"minChoices\": 0,\n \"maxChoices\": 3,\n \"type\": \"EXTRAS\",\n \"availableChoices\": [\n {\n \"itemId\": \"2b5131cd-7872-4ee8-ae40-cb00c6dcaec1\",\n \"price\": \"1.00\"\n },\n {\n \"itemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"price\": \"1.50\"\n },\n {\n \"itemId\": \"0f3fee4d-1b4a-4cfd-9c79-11a52e8e4024\",\n \"price\": \"1.50\"\n }\n ],\n \"defaultChoices\": [],\n \"selectedChoices\": [\n {\n \"quantity\": 1,\n \"price\": \"1.50\",\n \"comment\": null,\n \"dishOptions\": [],\n \"catalogReference\": {\n \"catalogItemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"catalogItemName\": \"Fried Beans\",\n \"catalogItemDescription\": null,\n \"catalogItemMedia\": null\n }\n }\n ]\n }\n ],\n \"catalogReference\": {\n \"catalogItemId\": \"142bddf2-4462-43c3-b048-4fc5afd5e4f8\",\n \"catalogItemName\": \"Beef Steak Taco\",\n \"catalogItemDescription\": \"with fresh veggies and Roasted Tomato Salsa\",\n \"catalogItemMedia\": \"https://static.wixstatic.com/media/cae3dea6ebc54972a96284b90dd97d73.jpg\"\n }\n },\n {\n \"quantity\": 6,\n \"price\": \"2.00\",\n \"comment\": null,\n \"dishOptions\": [],\n \"catalogReference\": {\n \"catalogItemId\": \"2f941cff-0f42-4fbc-90a2-7ceed8a8628b\",\n \"catalogItemName\": \"Chicken Taco\",\n \"catalogItemDescription\": \"with fresh veggies and Roasted Tomato Salsa\",\n \"catalogItemMedia\": \"https://static.wixstatic.com/media/11062bA4cabfdc2652413d92990cfac29777cc~mv2.jpg\"\n }\n },\n {\n \"quantity\": 5,\n \"price\": \"6.00\",\n \"comment\": null,\n \"dishOptions\": [\n {\n \"name\": \"Taco Options\",\n \"minChoices\": 0,\n \"maxChoices\": 2147483647,\n \"type\": \"EXTRAS\",\n \"availableChoices\": [\n {\n \"itemId\": \"2b5131cd-7872-4ee8-ae40-cb00c6dcaec1\",\n \"price\": \"1.00\"\n },\n {\n \"itemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"price\": \"1.50\"\n },\n {\n \"itemId\": \"0f3fee4d-1b4a-4cfd-9c79-11a52e8e4024\",\n \"price\": \"1.50\"\n }\n ],\n \"defaultChoices\": [],\n \"selectedChoices\": []\n }\n ],\n \"catalogReference\": {\n \"catalogItemId\": \"d6682658-c859-470c-9ef1-500969a486c9\",\n \"catalogItemName\": \"Chicken Burrito\",\n \"catalogItemDescription\": \"with rice, beans and lettuce\",\n \"catalogItemMedia\": \"https://static.wixstatic.com/media/11062bB944af5efcf44457b21a274f61a65316~mv2.jpg\"\n }\n }\n ],\n \"discounts\": [\n {\n \"catalogDiscountId\": \"bc697347-c180-494b-b68d-bc63ac63a84b\",\n \"appliedAmount\": \"15.00\",\n \"catalogDiscountType\": \"OFF_ORDER\",\n \"catalogDiscountName\": \"Sunday Order Discount\"\n }\n ],"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"},"httpMethod":"post","path":"/v3/orders/{id}/fulfill","rpcOnly":false,"triggeredEvents":[{"title":"Order Fulfilled","description":"Triggered when an order is fulfilled.","permissions":["WIX_RESTAURANTS.READ_ORDERS"],"payload":{"schemaName":"com.wixpress.restaurants.orders.v3.OrderFulfilled"},"exposure":"PUBLIC","maturity":"BETA","slug":"fulfilled","eventTopic":"domain_events_wix.restaurants.v3.order","serviceName":"com.wixpress.restaurants.orders.v3.OrdersApi","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"}],"serviceName":"com.wixpress.restaurants.orders.v3.OrdersApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_RESTAURANTS.MANAGE_ORDERS"],"externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-RESTAURANTS.MANAGE-ORDERS"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Restaurants_MEGASCOPE","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.restaurants:restaurants-orders-webapp","serviceArtifactId":"com.wixpress.restaurants.restaurants-orders-webapp","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.restaurants.orders.v3.FulfillOrderRequest","responseMessage":"com.wixpress.restaurants.orders.v3.FulfillOrderResponse"},"legacyExamples":[{"name":"FulfillOrder","type":"METHOD","content":{"title":"Fulfill Order","request":"curl -X POST \\\n 'https://www.wixapis.com/restaurants/v3/orders/64783425355/fulfill' \\\n -H 'Authorization: '","response":"{\n \"order\": {\n \"id\": \"64783425355\",\n \"createdDate\": \"2021-07-22T12:35:51.675Z\",\n \"updatedDate\": \"2021-07-07T12:37:44.994Z\",\n \"comment\": \"call when arriving to building\",\n \"currency\": \"USD\",\n \"status\": \"FULFILLED\",\n \"lineItems\": [\n {\n \"quantity\": 3,\n \"price\": \"2.00\",\n \"comment\": null,\n \"dishOptions\": [\n {\n \"name\": \"Taco Options\",\n \"minChoices\": 0,\n \"maxChoices\": 3,\n \"type\": \"EXTRAS\",\n \"availableChoices\": [\n {\n \"itemId\": \"2b5131cd-7872-4ee8-ae40-cb00c6dcaec1\",\n \"price\": \"1.00\"\n },\n {\n \"itemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"price\": \"1.50\"\n },\n {\n \"itemId\": \"0f3fee4d-1b4a-4cfd-9c79-11a52e8e4024\",\n \"price\": \"1.50\"\n }\n ],\n \"defaultChoices\": [],\n \"selectedChoices\": [\n {\n \"quantity\": 1,\n \"price\": \"1.50\",\n \"comment\": null,\n \"dishOptions\": [],\n \"catalogReference\": {\n \"catalogItemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"catalogItemName\": \"Fried Beans\",\n \"catalogItemDescription\": null,\n \"catalogItemMedia\": null\n }\n }\n ]\n }\n ],\n \"catalogReference\": {\n \"catalogItemId\": \"142bddf2-4462-43c3-b048-4fc5afd5e4f8\",\n \"catalogItemName\": \"Beef Steak Taco\",\n \"catalogItemDescription\": \"with fresh veggies and Roasted Tomato Salsa\",\n \"catalogItemMedia\": \"https://static.wixstatic.com/media/cae3dea6ebc54972a96284b90dd97d73.jpg\"\n }\n },\n {\n \"quantity\": 6,\n \"price\": \"2.00\",\n \"comment\": null,\n \"dishOptions\": [],\n \"catalogReference\": {\n \"catalogItemId\": \"2f941cff-0f42-4fbc-90a2-7ceed8a8628b\",\n \"catalogItemName\": \"Chicken Taco\",\n \"catalogItemDescription\": \"with fresh veggies and Roasted Tomato Salsa\",\n \"catalogItemMedia\": \"https://static.wixstatic.com/media/11062bA4cabfdc2652413d92990cfac29777cc~mv2.jpg\"\n }\n },\n {\n \"quantity\": 5,\n \"price\": \"6.00\",\n \"comment\": null,\n \"dishOptions\": [\n {\n \"name\": \"Taco Options\",\n \"minChoices\": 0,\n \"maxChoices\": 2147483647,\n \"type\": \"EXTRAS\",\n \"availableChoices\": [\n {\n \"itemId\": \"2b5131cd-7872-4ee8-ae40-cb00c6dcaec1\",\n \"price\": \"1.00\"\n },\n {\n \"itemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"price\": \"1.50\"\n },\n {\n \"itemId\": \"0f3fee4d-1b4a-4cfd-9c79-11a52e8e4024\",\n \"price\": \"1.50\"\n }\n ],\n \"defaultChoices\": [],\n \"selectedChoices\": []\n }\n ],\n \"catalogReference\": {\n \"catalogItemId\": \"d6682658-c859-470c-9ef1-500969a486c9\",\n \"catalogItemName\": \"Chicken Burrito\",\n \"catalogItemDescription\": \"with rice, beans and lettuce\",\n \"catalogItemMedia\": \"https://static.wixstatic.com/media/11062bB944af5efcf44457b21a274f61a65316~mv2.jpg\"\n }\n }\n ],\n \"discounts\": [\n {\n \"catalogDiscountId\": \"bc697347-c180-494b-b68d-bc63ac63a84b\",\n \"appliedAmount\": \"15.00\",\n \"catalogDiscountType\": \"OFF_ORDER\",\n \"catalogDiscountName\": \"Sunday Order Discount\"\n }\n ],"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","contentLink":{"displayName":"Fulfill Order","slugifiedName":"fulfill-order"}}],"webhooks":[{"summary":"Order Created","title":"Order Created","description":"> **Deprecation Notice**\n>\n> **The Order Created webhook has been replaced with**\n> **the [New Order webhook](https://dev.wix.com/api/rest/wix-restaurants/orders/new-order-webhook)**\n> **and will be removed on September 30, 2022. If your**\n> **app uses this webhook, we recommend updating your**\n> **code as soon as possible.**","permissions":["WIX_RESTAURANTS.READ_ORDERS"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.restaurants.v3.order","serviceName":"com.wixpress.restaurants.orders.v3.OrdersApi","domainEvent":"CREATED","externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-RESTAURANTS.MANAGE-ORDERS"},{"name":"Read Orders","scopeId":"SCOPE.DC-RESTAURANTS.READ-ORDERS"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Restaurants_MEGASCOPE","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"legacyExamples":[{"name":"OrderCreated","eventType":"CREATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"52269077-05f2-4b59-ba4f-36ef8c4c1e11\",\n \"entityFqdn\": \"wix.restaurants.v3.order\",\n \"slug\": \"created\",\n \"createdEvent\": {\n \"entityAsJson\": {\n \"order\": {\n \"id\": \"64783425355\",\n \"createdDate\": \"2021-07-07T10:37:44.994Z\",\n \"updatedDate\": \"2021-07-07T10:37:44.994Z\",\n \"comment\": \"No peanuts please\",\n \"currency\": \"USD\",\n \"status\": \"NEW\",\n \"lineItems\": [\n {\n \"quantity\": 5,\n \"price\": \"2.00\",\n \"comment\": null,\n \"dishOptions\": [\n {\n \"name\": \"Taco Options\",\n \"minChoices\": 0,\n \"maxChoices\": 3,\n \"type\": \"EXTRAS\",\n \"availableChoices\": [\n {\n \"itemId\": \"2b5131cd-7872-4ee8-ae40-cb00c6dcaec1\",\n \"price\": \"1.00\"\n },\n {\n \"itemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"price\": \"1.50\"\n },\n {\n \"itemId\": \"0f3fee4d-1b4a-4cfd-9c79-11a52e8e4024\",\n \"price\": \"1.50\"\n }\n ],\n \"defaultChoices\": [],\n \"selectedChoices\": [\n {\n \"quantity\": 1,\n \"price\": \"1.50\",\n \"comment\": null,\n \"dishOptions\": [],\n \"catalogReference\": {\n \"catalogItemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"catalogItemName\": \"Fried Beans\",\n \"catalogItemDescription\": null,\n \"catalogItemMedia\": null\n }\n }\n ]\n }\n ],\n \"catalogReference\": {\n \"catalogItemId\": \"81cddf94-dcad-4f0e-9c3c-7556e3dbd4d8\",\n \"catalogItemName\": \"Chicken Taco\",\n \"catalogItemDescription\": \"with fresh veggies and Roasted Tomato Salsa\",\n \"catalogItemMedia\": \"https://static.wixstatic.com/media/11062bA4cabfdc2652413d92990cfac29777cc~mv2.jpg\"\n }\n }\n ],\n \"discounts\": [\n {\n \"catalogDiscountId\": \"bc697347-c180-494b-b68d-bc63ac63a84b\",\n \"appliedAmount\": \"15.00\",\n \"catalogDiscountType\": \"OFF_ORDER\",\n \"catalogDiscountName\": \"Sunday Order Discount\"\n }\n ],\n \"payments\": [\n {\n \"type\": \"CASH\",\n \"amount\": \"10.00\",\n \"method\": \"offline\",\n \"providerTransactionId\": \"d9ef0f0c-e81a-4017-9d6a-977089eb411f\"\n }\n ],\n \"fulfillment\": {\n \"type\": \"DELIVERY\",\n \"promisedTime\": \"2021-07-07T11:17:44.994Z\",\n \"asap\": true,\n \"deliveryDetails\": {\n \"charge\": \"0.00\",\n \"address\": {\n \"formatted\": \"235 W 23rd St, New York, NY 10011, United States\",\n \"country\": null,\n \"city\": \"New York\",\n \"street\": \"West 23rd Street\",\n \"streetNumber\": \"235\",\n \"apt\": \"1\",\n \"floor\": \"3\",\n \"entrance\": null,\n \"zipCode\": \"10011-2302\",\n \"countryCode\": \"US\",\n \"onArrival\": \"UNSPECIFIED_ON_ARRIVAL_TYPE\",\n \"approximate\": false,\n \"comment\": null,\n \"location\": {\n \"latitude\": 40.7448484,\n \"longitude\": -73.9967498\n },\n \"addressLine2\": null\n }\n }\n },\n \"customer\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"phone\": \"2075556300\",\n \"email\": \"john@example.com\",\n \"contactId\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\"\n },\n \"totals\": {\n \"subtotal\": \"10.00\",\n \"total\": \"10.00\",\n \"delivery\": null,\n \"tax\": null,\n \"discount\": null,\n \"loyaltySavings\": null,\n \"quantity\": 1,\n \"tip\": null\n },\n \"activities\": [\n {\n \"timestamp\": \"2021-07-07T10:37:44.994Z\",\n \"message\": \"new\"\n }\n ],\n \"channelInfo\": {\n \"type\": \"WEB\"\n },\n \"coupon\": null,\n \"loyaltyInfo\": null\n }\n }\n },\n \"entityId\": \"64783425355\",\n \"eventTime\": \"2021-07-07T10:37:44.994Z\",\n \"triggeredByAnonymizeRequest\": false\n}"}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.Order","contentLink":{"displayName":"Order Created","slugifiedName":"order-created"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Order New Order","title":"Order New Order","description":"Triggered on successful creation of a new order. This means\nthe order has been validated and the payment has cleared,\nand now the site owner can accept or cancel the order.","permissions":["WIX_RESTAURANTS.READ_ORDERS"],"payload":{"schemaName":"com.wixpress.restaurants.orders.v3.NewOrder"},"exposure":"PUBLIC","maturity":"BETA","slug":"new_order","eventTopic":"domain_events_wix.restaurants.v3.order","serviceName":"com.wixpress.restaurants.orders.v3.OrdersApi","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-RESTAURANTS.MANAGE-ORDERS"},{"name":"Read Orders","scopeId":"SCOPE.DC-RESTAURANTS.READ-ORDERS"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Restaurants_MEGASCOPE","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"legacyExamples":[{"name":"NewOrder","eventType":"ORDER","type":"DOMAIN_EVENT","content":"{\n \"id\": \"52269077-05f2-4b59-ba4f-36ef8c4c1e11\",\n \"entityFqdn\": \"wix.restaurants.v3.order\",\n \"slug\": \"new_order\",\n \"actionEvent\": {\n \"bodyAsJson\": {\n \"order\": {\n \"id\": \"64783425355\",\n \"createdDate\": \"2021-07-07T10:37:44.994Z\",\n \"updatedDate\": \"2021-07-07T10:39:46.994Z\",\n \"comment\": \"No peanuts please\",\n \"currency\": \"USD\",\n \"status\": \"NEW\",\n \"lineItems\": [\n {\n \"quantity\": 5,\n \"price\": \"2.00\",\n \"comment\": null,\n \"dishOptions\": [\n {\n \"name\": \"Taco Options\",\n \"minChoices\": 0,\n \"maxChoices\": 3,\n \"type\": \"EXTRAS\",\n \"availableChoices\": [\n {\n \"itemId\": \"2b5131cd-7872-4ee8-ae40-cb00c6dcaec1\",\n \"price\": \"1.00\"\n },\n {\n \"itemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"price\": \"1.50\"\n },\n {\n \"itemId\": \"0f3fee4d-1b4a-4cfd-9c79-11a52e8e4024\",\n \"price\": \"1.50\"\n }\n ],\n \"defaultChoices\": [],\n \"selectedChoices\": [\n {\n \"quantity\": 1,\n \"price\": \"1.50\",\n \"comment\": null,\n \"dishOptions\": [],\n \"catalogReference\": {\n \"catalogItemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"catalogItemName\": \"Fried Beans\",\n \"catalogItemDescription\": null,\n \"catalogItemMedia\": null\n }\n }\n ]\n }\n ],\n \"catalogReference\": {\n \"catalogItemId\": \"81cddf94-dcad-4f0e-9c3c-7556e3dbd4d8\",\n \"catalogItemName\": \"Chicken Taco\",\n \"catalogItemDescription\": \"with fresh veggies and Roasted Tomato Salsa\",\n \"catalogItemMedia\": \"https://static.wixstatic.com/media/11062bA4cabfdc2652413d92990cfac29777cc~mv2.jpg\"\n }\n }\n ],\n \"discounts\": [\n {\n \"catalogDiscountId\": \"bc697347-c180-494b-b68d-bc63ac63a84b\",\n \"appliedAmount\": \"15.00\",\n \"catalogDiscountType\": \"OFF_ORDER\",\n \"catalogDiscountName\": \"Sunday Order Discount\"\n }\n ],\n \"payments\": [\n {\n \"type\": \"CASH\",\n \"amount\": \"10.00\",\n \"method\": \"offline\",\n \"providerTransactionId\": \"d9ef0f0c-e81a-4017-9d6a-977089eb411f\"\n }\n ],\n \"fulfillment\": {\n \"type\": \"DELIVERY\",\n \"promisedTime\": \"2021-07-07T11:17:44.994Z\",\n \"asap\": true,\n \"deliveryDetails\": {\n \"charge\": \"0.00\",\n \"address\": {\n \"formatted\": \"235 W 23rd St, New York, NY 10011, United States\",\n \"country\": null,\n \"city\": \"New York\",\n \"street\": \"West 23rd Street\",\n \"streetNumber\": \"235\",\n \"apt\": \"1\",\n \"floor\": \"3\",\n \"entrance\": null,\n \"zipCode\": \"10011-2302\",\n \"countryCode\": \"US\",\n \"onArrival\": \"UNSPECIFIED_ON_ARRIVAL_TYPE\",\n \"approximate\": false,\n \"comment\": null,\n \"location\": {\n \"latitude\": 40.7448484,\n \"longitude\": -73.9967498\n },\n \"addressLine2\": null\n }\n }\n },\n \"customer\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"phone\": \"2075556300\",\n \"email\": \"john@example.com\",\n \"contactId\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\"\n },\n \"totals\": {\n \"subtotal\": \"10.00\",\n \"total\": \"10.00\",\n \"delivery\": null,\n \"tax\": null,\n \"discount\": null,\n \"loyaltySavings\": null,\n \"quantity\": 1,\n \"tip\": null\n },\n \"activities\": [\n {\n \"timestamp\": \"2021-07-07T10:37:44.994Z\",\n \"message\": \"new\"\n },\n {\n \"timestamp\": \"2021-07-07T10:39:46.994Z\",\n \"message\": \"accepted []\"\n }\n ],\n \"channelInfo\": {\n \"type\": \"WEB\"\n },\n \"coupon\": null,\n \"loyaltyInfo\": null\n }\n }\n },\n \"entityId\": \"64783425355\",\n \"eventTime\": \"2021-07-07T10:47:44.994Z\",\n \"triggeredByAnonymizeRequest\": false\n}"}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.NewOrder","contentLink":{"displayName":"New Order","slugifiedName":"new-order"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Order Accepted","title":"Order Accepted","description":"Triggered when an order is accepted.","permissions":["WIX_RESTAURANTS.READ_ORDERS"],"payload":{"schemaName":"com.wixpress.restaurants.orders.v3.OrderAccepted"},"exposure":"PUBLIC","maturity":"BETA","slug":"accepted","eventTopic":"domain_events_wix.restaurants.v3.order","serviceName":"com.wixpress.restaurants.orders.v3.OrdersApi","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-RESTAURANTS.MANAGE-ORDERS"},{"name":"Read Orders","scopeId":"SCOPE.DC-RESTAURANTS.READ-ORDERS"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Restaurants_MEGASCOPE","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"legacyExamples":[{"name":"OrderAccepted","eventType":"ACCEPTED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"52269077-05f2-4b59-ba4f-36ef8c4c1e11\",\n \"entityFqdn\": \"wix.restaurants.v3.order\",\n \"slug\": \"accepted\",\n \"actionEvent\": {\n \"bodyAsJson\": {\n \"order\": {\n \"id\": \"64783425355\",\n \"createdDate\": \"2021-07-07T10:37:44.994Z\",\n \"updatedDate\": \"2021-07-07T10:39:46.994Z\",\n \"comment\": \"No peanuts please\",\n \"currency\": \"USD\",\n \"status\": \"ACCEPTED\",\n \"lineItems\": [\n {\n \"quantity\": 5,\n \"price\": \"2.00\",\n \"comment\": null,\n \"dishOptions\": [\n {\n \"name\": \"Taco Options\",\n \"minChoices\": 0,\n \"maxChoices\": 3,\n \"type\": \"EXTRAS\",\n \"availableChoices\": [\n {\n \"itemId\": \"2b5131cd-7872-4ee8-ae40-cb00c6dcaec1\",\n \"price\": \"1.00\"\n },\n {\n \"itemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"price\": \"1.50\"\n },\n {\n \"itemId\": \"0f3fee4d-1b4a-4cfd-9c79-11a52e8e4024\",\n \"price\": \"1.50\"\n }\n ],\n \"defaultChoices\": [],\n \"selectedChoices\": [\n {\n \"quantity\": 1,\n \"price\": \"1.50\",\n \"comment\": null,\n \"dishOptions\": [],\n \"catalogReference\": {\n \"catalogItemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"catalogItemName\": \"Fried Beans\",\n \"catalogItemDescription\": null,\n \"catalogItemMedia\": null\n }\n }\n ]\n }\n ],\n \"catalogReference\": {\n \"catalogItemId\": \"81cddf94-dcad-4f0e-9c3c-7556e3dbd4d8\",\n \"catalogItemName\": \"Chicken Taco\",\n \"catalogItemDescription\": \"with fresh veggies and Roasted Tomato Salsa\",\n \"catalogItemMedia\": \"https://static.wixstatic.com/media/11062bA4cabfdc2652413d92990cfac29777cc~mv2.jpg\"\n }\n }\n ],\n \"discounts\": [\n {\n \"catalogDiscountId\": \"bc697347-c180-494b-b68d-bc63ac63a84b\",\n \"appliedAmount\": \"15.00\",\n \"catalogDiscountType\": \"OFF_ORDER\",\n \"catalogDiscountName\": \"Sunday Order Discount\"\n }\n ],\n \"payments\": [\n {\n \"type\": \"CASH\",\n \"amount\": \"10.00\",\n \"method\": \"offline\",\n \"providerTransactionId\": \"d9ef0f0c-e81a-4017-9d6a-977089eb411f\"\n }\n ],\n \"fulfillment\": {\n \"type\": \"DELIVERY\",\n \"promisedTime\": \"2021-07-07T11:17:44.994Z\",\n \"asap\": true,\n \"deliveryDetails\": {\n \"charge\": \"0.00\",\n \"address\": {\n \"formatted\": \"235 W 23rd St, New York, NY 10011, United States\",\n \"country\": null,\n \"city\": \"New York\",\n \"street\": \"West 23rd Street\",\n \"streetNumber\": \"235\",\n \"apt\": \"1\",\n \"floor\": \"3\",\n \"entrance\": null,\n \"zipCode\": \"10011-2302\",\n \"countryCode\": \"US\",\n \"onArrival\": \"UNSPECIFIED_ON_ARRIVAL_TYPE\",\n \"approximate\": false,\n \"comment\": null,\n \"location\": {\n \"latitude\": 40.7448484,\n \"longitude\": -73.9967498\n },\n \"addressLine2\": null\n }\n }\n },\n \"customer\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"phone\": \"2075556300\",\n \"email\": \"john@example.com\",\n \"contactId\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\"\n },\n \"totals\": {\n \"subtotal\": \"10.00\",\n \"total\": \"10.00\",\n \"delivery\": null,\n \"tax\": null,\n \"discount\": null,\n \"loyaltySavings\": null,\n \"quantity\": 1,\n \"tip\": null\n },\n \"activities\": [\n {\n \"timestamp\": \"2021-07-07T10:37:44.994Z\",\n \"message\": \"new\"\n },\n {\n \"timestamp\": \"2021-07-07T10:39:46.994Z\",\n \"message\": \"accepted []\"\n }\n ],\n \"channelInfo\": {\n \"type\": \"WEB\"\n },\n \"coupon\": null,\n \"loyaltyInfo\": null\n }\n }\n },\n \"entityId\": \"64783425355\",\n \"eventTime\": \"2021-07-07T10:47:44.994Z\",\n \"triggeredByAnonymizeRequest\": false\n}"}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.OrderAccepted","contentLink":{"displayName":"Order Accepted","slugifiedName":"order-accepted"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Order Canceled","title":"Order Canceled","description":"Triggered when an order is canceled.","permissions":["WIX_RESTAURANTS.READ_ORDERS"],"payload":{"schemaName":"com.wixpress.restaurants.orders.v3.OrderCanceled"},"exposure":"PUBLIC","maturity":"BETA","slug":"canceled","eventTopic":"domain_events_wix.restaurants.v3.order","serviceName":"com.wixpress.restaurants.orders.v3.OrdersApi","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-RESTAURANTS.MANAGE-ORDERS"},{"name":"Read Orders","scopeId":"SCOPE.DC-RESTAURANTS.READ-ORDERS"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Restaurants_MEGASCOPE","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"legacyExamples":[{"name":"OrderCanceled","eventType":"CANCELED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"52269077-05f2-4b59-ba4f-36ef8c4c1e11\",\n \"entityFqdn\": \"wix.restaurants.v3.order\",\n \"slug\": \"canceled\",\n \"actionEvent\": {\n \"bodyAsJson\": {\n \"order\": {\n \"id\": \"64783425355\",\n \"createdDate\": \"2021-07-22T12:35:51.675Z\",\n \"updatedDate\": \"2021-07-07T10:39:46.994Z\",\n \"comment\": \"no need for cutlery\",\n \"currency\": \"USD\",\n \"status\": \"CANCELED\",\n \"lineItems\": [\n {\n \"quantity\": 5,\n \"price\": \"2.00\",\n \"comment\": null,\n \"dishOptions\": [\n {\n \"name\": \"Taco Options\",\n \"minChoices\": 0,\n \"maxChoices\": 3,\n \"type\": \"EXTRAS\",\n \"availableChoices\": [\n {\n \"itemId\": \"2b5131cd-7872-4ee8-ae40-cb00c6dcaec1\",\n \"price\": \"1.00\"\n },\n {\n \"itemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"price\": \"1.50\"\n },\n {\n \"itemId\": \"0f3fee4d-1b4a-4cfd-9c79-11a52e8e4024\",\n \"price\": \"1.50\"\n }\n ],\n \"defaultChoices\": [],\n \"selectedChoices\": [\n {\n \"quantity\": 1,\n \"price\": \"1.50\",\n \"comment\": null,\n \"dishOptions\": [],\n \"catalogReference\": {\n \"catalogItemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"catalogItemName\": \"Fried Beans\",\n \"catalogItemDescription\": null,\n \"catalogItemMedia\": null\n }\n }\n ]\n }\n ],\n \"catalogReference\": {\n \"catalogItemId\": \"81cddf94-dcad-4f0e-9c3c-7556e3dbd4d8\",\n \"catalogItemName\": \"Chicken Taco\",\n \"catalogItemDescription\": \"with fresh veggies and Roasted Tomato Salsa\",\n \"catalogItemMedia\": \"https://static.wixstatic.com/media/11062bA4cabfdc2652413d92990cfac29777cc~mv2.jpg\"\n }\n }\n ],\n \"discounts\": [\n {\n \"catalogDiscountId\": \"bc697347-c180-494b-b68d-bc63ac63a84b\",\n \"appliedAmount\": \"15.00\",\n \"catalogDiscountType\": \"OFF_ORDER\",\n \"catalogDiscountName\": \"Sunday Order Discount\"\n }\n ],\n \"payments\": [\n {\n \"type\": \"WIX_PAYMENTS\",\n \"amount\": \"10.00\",\n \"method\": \"offline\",\n \"providerTransactionId\": \"d9ef0f0c-e81a-4017-9d6a-977089eb411f\"\n }\n ],\n \"fulfillment\": {\n \"type\": \"DELIVERY\",\n \"promisedTime\": \"2021-04-22T11:20:52.171Z\",\n \"asap\": true,\n \"deliveryDetails\": {\n \"charge\": \"0.00\",\n \"address\": {\n \"formatted\": \"235 W 23rd St, New York, NY 10011, United States\",\n \"country\": null,\n \"city\": \"New York\",\n \"street\": \"West 23rd Street\",\n \"streetNumber\": \"235\",\n \"apt\": \"1\",\n \"floor\": \"3\",\n \"entrance\": null,\n \"zipCode\": \"10011-2302\",\n \"countryCode\": \"US\",\n \"onArrival\": \"UNSPECIFIED_ON_ARRIVAL_TYPE\",\n \"approximate\": false,\n \"comment\": null,\n \"location\": {\n \"latitude\": 40.7448484,\n \"longitude\": -73.9967498\n },\n \"addressLine2\": null\n }\n }\n },\n \"customer\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"phone\": \"2075556300\",\n \"email\": \"john@example.com\",\n \"contactId\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\"\n },\n \"totals\": {\n \"subtotal\": \"10.00\",\n \"total\": \"10.00\",\n \"delivery\": null,\n \"tax\": null,\n \"discount\": null,\n \"loyaltySavings\": null,\n \"quantity\": 1,\n \"tip\": null\n },\n \"activities\": [\n {\n \"timestamp\": \"2021-07-07T10:37:44.994Z\",\n \"message\": \"new\"\n },\n {\n \"timestamp\": \"2021-07-07T10:39:46.994Z\",\n \"message\": \"canceled [ordered wrong dish]\"\n }\n ],\n \"channelInfo\": {\n \"type\": \"WEB\"\n },\n \"coupon\": null,\n \"loyaltyInfo\": null\n }\n }\n },\n \"entityId\": \"64783425355\",\n \"eventTime\": \"2021-07-07T11:06:29.737Z\",\n \"triggeredByAnonymizeRequest\": false\n}"}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.OrderCanceled","contentLink":{"displayName":"Order Canceled","slugifiedName":"order-canceled"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Order Fulfilled","title":"Order Fulfilled","description":"Triggered when an order is fulfilled.","permissions":["WIX_RESTAURANTS.READ_ORDERS"],"payload":{"schemaName":"com.wixpress.restaurants.orders.v3.OrderFulfilled"},"exposure":"PUBLIC","maturity":"BETA","slug":"fulfilled","eventTopic":"domain_events_wix.restaurants.v3.order","serviceName":"com.wixpress.restaurants.orders.v3.OrdersApi","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-RESTAURANTS.MANAGE-ORDERS"},{"name":"Read Orders","scopeId":"SCOPE.DC-RESTAURANTS.READ-ORDERS"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Restaurants_MEGASCOPE","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"legacyExamples":[{"name":"OrderFulfilled","eventType":"FULFILLED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"52269077-05f2-4b59-ba4f-36ef8c4c1e11\",\n \"entityFqdn\": \"wix.restaurants.v3.order\",\n \"slug\": \"fulfilled\",\n \"actionEvent\": {\n \"bodyAsJson\": {\n \"order\": {\n \"id\": \"64783425355\",\n \"createdDate\": \"2021-07-22T12:35:51.675Z\",\n \"updatedDate\": \"2021-07-07T12:37:44.994Z\",\n \"comment\": \"call when arriving to building\",\n \"currency\": \"USD\",\n \"status\": \"FULFILLED\",\n \"lineItems\": [\n {\n \"quantity\": 3,\n \"price\": \"2.00\",\n \"comment\": null,\n \"dishOptions\": [\n {\n \"name\": \"Taco Options\",\n \"minChoices\": 0,\n \"maxChoices\": 3,\n \"type\": \"EXTRAS\",\n \"availableChoices\": [\n {\n \"itemId\": \"2b5131cd-7872-4ee8-ae40-cb00c6dcaec1\",\n \"price\": \"1.00\"\n },\n {\n \"itemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"price\": \"1.50\"\n },\n {\n \"itemId\": \"0f3fee4d-1b4a-4cfd-9c79-11a52e8e4024\",\n \"price\": \"1.50\"\n }\n ],\n \"defaultChoices\": [],\n \"selectedChoices\": [\n {\n \"quantity\": 1,\n \"price\": \"1.50\",\n \"comment\": null,\n \"dishOptions\": [],\n \"catalogReference\": {\n \"catalogItemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"catalogItemName\": \"Fried Beans\",\n \"catalogItemDescription\": null,\n \"catalogItemMedia\": null\n }\n }\n ]\n }\n ],\n \"catalogReference\": {\n \"catalogItemId\": \"142bddf2-4462-43c3-b048-4fc5afd5e4f8\",\n \"catalogItemName\": \"Beef Steak Taco\",\n \"catalogItemDescription\": \"with fresh veggies and Roasted Tomato Salsa\",\n \"catalogItemMedia\": \"https://static.wixstatic.com/media/cae3dea6ebc54972a96284b90dd97d73.jpg\"\n }\n },\n {\n \"quantity\": 6,\n \"price\": \"2.00\",\n \"comment\": null,\n \"dishOptions\": [],\n \"catalogReference\": {\n \"catalogItemId\": \"2f941cff-0f42-4fbc-90a2-7ceed8a8628b\",\n \"catalogItemName\": \"Chicken Taco\",\n \"catalogItemDescription\": \"with fresh veggies and Roasted Tomato Salsa\",\n \"catalogItemMedia\": \"https://static.wixstatic.com/media/11062bA4cabfdc2652413d92990cfac29777cc~mv2.jpg\"\n }\n },\n {\n \"quantity\": 5,\n \"price\": \"6.00\",\n \"comment\": null,\n \"dishOptions\": [\n {\n \"name\": \"Taco Options\",\n \"minChoices\": 0,\n \"maxChoices\": 2147483647,\n \"type\": \"EXTRAS\",\n \"availableChoices\": [\n {\n \"itemId\": \"2b5131cd-7872-4ee8-ae40-cb00c6dcaec1\",\n \"price\": \"1.00\"\n },\n {\n \"itemId\": \"d5e1b8f4-f18e-4fba-8ef4-33ad632b6c40\",\n \"price\": \"1.50\"\n },\n {\n \"itemId\": \"0f3fee4d-1b4a-4cfd-9c79-11a52e8e4024\",\n \"price\": \"1.50\"\n }\n ],\n \"defaultChoices\": [],\n \"selectedChoices\": []\n }\n ],\n \"catalogReference\": {\n \"catalogItemId\": \"d6682658-c859-470c-9ef1-500969a486c9\",\n \"catalogItemName\": \"Chicken Burrito\",\n \"catalogItemDescription\": \"with rice, beans and lettuce\",\n \"catalogItemMedia\": \"https://static.wixstatic.com/media/11062bB944af5efcf44457b21a274f61a65316~mv2.jpg\"\n }\n }\n ],\n \"discounts\": [\n {\n \"catalogDiscountId\": \"bc697347-c180-494b-b68d-bc63ac63a84b\",\n \"appliedAmount\": \"15.00\",\n \"catalogDiscountType\": \"OFF_ORDER\",\n \"catalogDiscountName\": \"Sunday Order Discount\"\n }\n ],\n \"payments\": [\n {\n \"type\": \"WIX_PAYMENTS\",\n \"amount\": \"33.00\",\n \"method\": \"offline\",\n \"providerTransactionId\": \"55d1ff37-7e9c-4c0f-9ec4-7d6d267019a4\"\n }\n ],\n \"fulfillment\": {\n \"type\": \"DELIVERY\",\n \"promisedTime\": \"2021-07-22T13:00:51.675Z\",\n \"asap\": true,\n \"deliveryDetails\": {\n \"charge\": \"0.00\",\n \"address\": {\n \"formatted\": \"235 W 23rd St, New York, NY 10011, United States\",\n \"country\": null,\n \"city\": \"New York\",\n \"street\": \"West 23rd Street\",\n \"streetNumber\": \"235\",\n \"apt\": null,\n \"floor\": null,\n \"entrance\": null,\n \"zipCode\": \"10011\",\n \"countryCode\": \"US\",\n \"onArrival\": \"UNSPECIFIED_ON_ARRIVAL_TYPE\",\n \"approximate\": false,\n \"comment\": null,\n \"location\": {\n \"latitude\": 40.74481129999999,\n \"longitude\": -73.99674399999999\n },\n \"addressLine2\": null\n }\n }\n },\n \"customer\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"phone\": \"2075556300\",\n \"email\": \"john@example.com\",\n \"contactId\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\"\n },\n \"totals\": {\n \"subtotal\": \"10.00\",\n \"total\": \"10.00\",\n \"delivery\": null,\n \"tax\": null,\n \"discount\": null,\n \"loyaltySavings\": null,\n \"quantity\": 1,\n \"tip\": null\n },\n \"activities\": [\n {\n \"timestamp\": \"2021-07-07T10:37:44.994Z\",\n \"message\": \"new\"\n },\n {\n \"timestamp\": \"2021-07-07T10:39:46.994Z\",\n \"message\": \"accepted []\"\n },\n {\n \"timestamp\": \"2021-07-07T10:50:55.994Z\",\n \"message\": \"fulfilled\"\n }\n ],\n \"channelInfo\": {\n \"type\": \"WEB\"\n },\n \"coupon\": null,\n \"loyaltyInfo\": null\n }\n }\n },\n \"entityId\": \"64783425355\",\n \"eventTime\": \"2021-07-07T10:47:44.994Z\",\n \"triggeredByAnonymizeRequest\": false\n}"}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.OrderFulfilled","contentLink":{"displayName":"Order Fulfilled","slugifiedName":"order-fulfilled"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About Wix Restaurants Orders\n\n> **Note:** This API only works with the original Wix Restaurants Orders app. Call [GetAppInstance](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::5a829a3f-423e-484e-80c5-b70320bf9383slug::get-app-instance*fallback::https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/get-app-instance) to confirm that the app named “restaurants_orders” is installed on the site.\n\nWith Wix Restaurants Orders, site owners can retrieve orders and update their statuses. They can also receive a notification when a new order has been placed.\n\nThe Orders API allows your app to:\n\n* Retrieve orders\n* Mark orders as **accepted**, **fulfilled**, and **canceled**\n* Listen to domain events\n\n## Terminology\n\n* **Catalog:** All **menus**.\n* **Line Item:** Any **dish** or **dish option** defined in the catalog.\n* **Dish Option:** Any **extra** that you can add to a dish, any **size** of the dish, or any **deselection** that you can remove from the dish.\n* **Discount:** A price reduction for an **item** or the **order**. The discount can be an amount, a percentage or free delivery. Discounts may depend on entering a coupon code.\n* **Order Statuses**:\n * **Pending:** The order has been placed by the customer, but the payment or validation checks have not cleared yet.\n\n > **Note:** Site owners can't see **pending** orders in their dashboard.\n * **New:** The order has passed validation checks and the payment has cleared, but the site owners have not **accepted** or **canceled** the order yet.\n * **Accepted:** The site owners have agreed to fulfill the order.\n > **Note:** Site owners can set up an automation in the dashboard to immediately accept every **new** order.\n * **Canceled:** The site owners have decided not to fulfill the order or to mark an already **fulfilled** order as problematic.\n * **Fulfilled:** The order has been successfully distributed.\n\n## Limitations\n\n* **Discounts:** Percentage discounts can only be applied to an item but not the entire order.\n* Currently the Restaurants Orders API doesn’t include create functionality. You can update order statuses and listen to domain events.\n","sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","path":"proto/docs/intro.md"},{"displayName":"Example Flow","slugifyName":"example-flow","content":"# Sample Use Case & Flow: Wix Restaurants Orders\n\nThis article shares a possible use case your app could support, as well as an example flow. \nYou're certainly not limited to this use case, but it can be a helpful jumping off point \nas you plan your app's implementation.\n\n## Sync Orders Placed on Wix Restaurants with an External POS\n\nIn order to enable site owners to sync their external POS with Wix Restaurants Orders \ndata, your app will need to retrieve each new order that is placed in Wix Restaurants. \nThen you can create a mapping to keep the order statuses synced. \n\n1. Sign up for the [New Order Domain Event](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::0f61c670-a569-4683-a32e-db82300d1471slug::new-order*fallback::https://dev.wix.com/api/rest/wix-restaurants/orders/new-order-webhook).\n2. Create a mapping between Wix Restaurants and the external POS. Store the mapping on your servers.\n3. Get notified when a new order has been placed on Wix Restaurants and add it to the mapping.\n4. Add the order to the external POS.\n\n > **Note:** Make sure to include both Wix Restaurants `orderId` and external order ID in the mapping.\n5. Change the order status on Wix Restaurants according to events in the external POS. Use the [Accept Order](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::0f61c670-a569-4683-a32e-db82300d1471slug::accept-order*fallback::https://dev.wix.com/api/rest/wix-restaurants/orders/accept-order), [Fulfill Order](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::0f61c670-a569-4683-a32e-db82300d1471slug::fulfill-order*fallback::https://dev.wix.com/api/rest/wix-restaurants/orders/fulfill-order), and [Cancel Order](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::0f61c670-a569-4683-a32e-db82300d1471slug::cancel-order*fallback::https://dev.wix.com/api/rest/wix-restaurants/orders/cancel-order) endpoints.\n","sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","path":"proto/docs/flow.md"},{"displayName":"Supported Field Masks","slugifyName":"supported-field-masks","content":"# Field Masks\n\nThe [List Orders](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::0f61c670-a569-4683-a32e-db82300d1471slug::list-orders*fallback::https://dev.wix.com/api/rest/wix-restaurants/orders/list-orders) \nand [Get Order](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::0f61c670-a569-4683-a32e-db82300d1471slug::get-order*fallback::https://dev.wix.com/api/rest/wix-restaurants/orders/get-order) endpoints \nallow you to return a partial `order` object\nincluding only the fields you request.\nTo do this, you can use projected fields in the `fieldMask.paths` array in your request.\n\n## Supported Projected Fields\n\nThe following fields can be returned in a partial object\nby specifying them in `fieldMask.paths`:\n\n> **Note:**\n> `id` and `revision` are always returned,\n> even if you don’t include them in the `fieldMask.paths` array in your request.\n\n- `id` \n- `revision`\n- `created_date`\n- `updated_date`\n- `comment`\n- `currency`\n- `status`\n- `line_items`\n- `discounts` \n- `payments`\n- `activities` \n- `channel_info`\n- `channel_info.type` \n- `coupon.code`\n- `coupon.id`\n- `fulfillment` \n- `fulfillment.type`\n- `fulfillment.promised_time`\n- `fulfillment.asap`\n- `fulfillment.delivery_details`\n- `fulfillment.delivery_details.charge`\n- `fulfillment.delivery_details.address`\n- `fulfillment.delivery_details.address.formatted`\n- `fulfillment.delivery_details.address.country`\n- `fulfillment.delivery_details.address.city`\n- `fulfillment.delivery_details.address.street`\n- `fulfillment.delivery_details.address.street_number`\n- `fulfillment.delivery_details.address.apt`\n- `fulfillment.delivery_details.address.floor`\n- `fulfillment.delivery_details.address.entrance`\n- `fulfillment.delivery_details.address.zip_code`\n- `fulfillment.delivery_details.address.country_code`\n- `fulfillment.delivery_details.address.approximate`\n- `fulfillment.delivery_details.address.comment`\n- `fulfillment.delivery_details.address.address_line2`\n- `fulfillment.delivery_details.address.on_arrival`\n- `fulfillment.delivery_details.address.location`\n- `fulfillment.delivery_details.address.location.latitude`\n- `fulfillment.delivery_details.address.location.longitude` \n- `fulfillment.pickup_details`\n- `fulfillment.pickup_details.fee`\n- `fulfillment.pickup_details.curbside`\n- `fulfillment.pickup_details.curbside.info`\n- `fulfillment.dine_in_details`\n- `fulfillment.dine_in_details.label`\n- `fulfillment.dine_in_details.value`\n- `customer`\n- `customer.first_name`\n- `customer.last_name`\n- `customer.phone`\n- `customer.email`\n- `customer.contact_id`\n- `customer.member_id`\n- `customer.visitor_id`\n- `totals` \n- `totals.subtotal`\n- `totals.total`\n- `totals.delivery`\n- `totals.tax`\n- `totals.quantity`\n- `totals.loyalty_savings`\n- `totals.tip`\n- `loyalty_info`\n- `loyalty_info.reward_id`\n- `loyalty_info.applied_amount`\n- `loyalty_info.redeemed_points`\n- `loyalty_info.transaction_id`\n- `loyalty_info.estimated_account_balance`\n- `loyalty_info.estimated_points_earned`\n- `loyalty_info.reward_revision`\n","sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","path":"proto/docs/field-mask.md"}],"components":{"schemas":{"com.wixpress.restaurants.orders.v3.Order":{"type":"object","properties":{"id":{"title":"id","description":"Order ID.","readOnly":true,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"locationId":{"title":"locationId","description":"ID of the restaurant’s location.","format":"GUID","readOnly":true,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"createdDate":{"title":"createdDate","description":"Order creation date and time in `yyyy-mm-ddThh:mm:sssZ` format.","readOnly":true,"type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"updatedDate":{"title":"updatedDate","description":"Date and time of order's latest update in `yyyy-mm-ddThh:mm:sssZ` format.","readOnly":true,"type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"comment":{"title":"comment","description":"Additional note to the order added by the customer.","maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"currency":{"title":"currency","description":"Currency of the order.","format":"CURRENCY","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"status":{"title":"status","description":"Current order status.","type":"string","$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.Status","x-wix-docs":{"exposure":"PUBLIC"}},"lineItems":{"title":"lineItems","description":"Dishes and options included in the order.","minItems":1,"maxItems":300,"type":"array","items":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.LineItem"},"x-wix-docs":{"exposure":"PUBLIC"}},"discounts":{"title":"discounts","description":"Discounts associated with the order.","minItems":0,"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.Discount"},"x-wix-docs":{"exposure":"PUBLIC"}},"coupon":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.Coupon","summary":"coupon","description":"Coupon applied to the order.","x-wix-docs":{"exposure":"PUBLIC"}},"payments":{"title":"payments","description":"Order payment information.","minItems":1,"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.Payment"},"x-wix-docs":{"exposure":"PUBLIC"}},"fulfillment":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.Fulfillment","summary":"fulfillment","description":"Order fulfillment information.","x-wix-docs":{"exposure":"PUBLIC"}},"customer":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.Customer","summary":"customer","description":"Customer information.","x-wix-docs":{"exposure":"PUBLIC"}},"totals":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.Totals","summary":"totals","description":"Order totals.","x-wix-docs":{"exposure":"PUBLIC"}},"activities":{"title":"activities","description":"Log of order updates.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.Activity"},"x-wix-docs":{"exposure":"PUBLIC"}},"channelInfo":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.ChannelInfo","summary":"channelInfo","description":"Information about the sales channel that submitted the order.","x-wix-docs":{"exposure":"PUBLIC"}},"loyaltyInfo":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.LoyaltyInfo","summary":"loyaltyInfo","description":"Information about the order’s loyalty points.\nLearn more about the [Wix Loyalty Program](https://dev.wix.com/api/rest/wix-loyalty-program/introduction).","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Order","description":""},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"title":"value","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"StringValue","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"title":"seconds","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"nanos":{"title":"nanos","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Timestamp","description":""},"com.wixpress.restaurants.orders.v3.Status":{"type":"string","description":"This might be extended in the future with pending orders statuses","title":"Status","enum":["UNSPECIFIED_ORDER_STATUS","PENDING","NEW","ACCEPTED","CANCELED","FULFILLED"]},"com.wixpress.restaurants.orders.v3.LineItem":{"type":"object","properties":{"quantity":{"title":"quantity","description":"Line item quantity.","minimum":1,"maximum":100000,"type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"price":{"title":"price","description":"Line item price.","type":"string","x-wix-docs":{"exposure":"PUBLIC","decimalValue":{"maxScale":2}}},"comment":{"title":"comment","description":"Comment about the line item added by the customer.","maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"dishOptions":{"title":"dishOptions","description":"List of all dish options available for the line item.","minItems":0,"maxItems":300,"type":"array","items":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.LineItemOption"},"x-wix-docs":{"exposure":"PUBLIC"}},"catalogReference":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.LineItem.CatalogReference","summary":"catalogReference","description":"References to the line item’s origin catalog.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"LineItem","description":""},"com.wixpress.restaurants.orders.v3.LineItemOption":{"type":"object","properties":{"name":{"title":"name","description":"Line item option name.","maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"selectedChoices":{"title":"selectedChoices","description":"List of all dish options selected by the customer.","minItems":0,"maxItems":300,"type":"array","items":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.LineItem"},"x-wix-docs":{"exposure":"PUBLIC"}},"minChoices":{"title":"minChoices","description":"Minimum number of dish options the customer is required to choose.","minimum":0,"maximum":2147483647,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"maxChoices":{"title":"maxChoices","description":"Maximum number of dish options the customer is allowed to choose.","minimum":1,"maximum":2147483647,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"type":{"title":"type","description":"Dish option type.","type":"string","$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.LineItemOption.DisplayType","x-wix-docs":{"exposure":"PUBLIC"}},"availableChoices":{"title":"availableChoices","description":"List of all available choices for the dish option.","minItems":1,"maxItems":300,"type":"array","items":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.LineItemOptionItem"},"x-wix-docs":{"exposure":"PUBLIC"}},"defaultChoices":{"title":"defaultChoices","description":"List of dish option IDs selected by default.","minItems":0,"maxItems":300,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"LineItemOption","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"title":"value","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Int32Value","description":""},"com.wixpress.restaurants.orders.v3.LineItemOption.DisplayType":{"type":"string","description":"","title":"DisplayType","enum":["UNSPECIFIED_DISPLAY_TYPE","SELECTION","EXTRAS","DESELECTION"]},"com.wixpress.restaurants.orders.v3.LineItemOptionItem":{"type":"object","properties":{"itemId":{"title":"itemId","description":"Line item ID as defined in the catalog.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"price":{"title":"price","description":"Line item price.","type":"string","x-wix-docs":{"exposure":"PUBLIC","decimalValue":{"maxScale":2}}},"name":{"title":"name","description":"Line item name.","maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"LineItemOptionItem","description":""},"com.wixpress.restaurants.orders.v3.LineItem.CatalogReference":{"type":"object","properties":{"catalogItemId":{"title":"catalogItemId","description":"Line item ID as defined in the catalog.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"catalogItemName":{"title":"catalogItemName","description":"Line item name as defined in the catalog.","maxLength":1000,"readOnly":true,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"catalogItemDescription":{"title":"catalogItemDescription","description":"Item description as defined in the catalog.","maxLength":1000,"readOnly":true,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"catalogItemMedia":{"title":"catalogItemMedia","description":"Item media url as defined in the catalog.","format":"URI","readOnly":true,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CatalogReference","description":""},"com.wixpress.restaurants.orders.v3.Discount":{"type":"object","properties":{"catalogDiscountId":{"title":"catalogDiscountId","description":"Discount ID as defined in the catalog.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"appliedAmount":{"title":"appliedAmount","description":"Amount saved.","type":"string","x-wix-docs":{"exposure":"PUBLIC","decimalValue":{"maxScale":2}}},"catalogDiscountType":{"title":"catalogDiscountType","description":"Discount type.","type":"string","$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.Discount.DiscountType","x-wix-docs":{"exposure":"PUBLIC"}},"catalogDiscountName":{"title":"catalogDiscountName","description":"Discount name as defined in the catalog.","minLength":1,"maxLength":256,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"catalogDiscountDescription":{"title":"catalogDiscountDescription","description":"Discount description as defined in the catalog.\n\nMax: 1,000 characters","minLength":1,"maxLength":1000,"readOnly":true,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Discount","description":""},"com.wixpress.restaurants.orders.v3.Discount.DiscountType":{"type":"string","description":"","title":"DiscountType","enum":["UNSPECIFIED_TYPE","OFF_ITEM","OFF_ORDER","OFF_ORDER_MANAGER_DISCOUNT"]},"com.wixpress.restaurants.orders.v3.Coupon":{"type":"object","properties":{"code":{"title":"code","description":"Coupon code.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"id":{"title":"id","description":"Coupon ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Coupon","description":""},"com.wixpress.restaurants.orders.v3.Payment":{"type":"object","properties":{"type":{"title":"type","description":"Payment type.","type":"string","$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.Payment.Type","x-wix-docs":{"exposure":"PUBLIC"}},"amount":{"title":"amount","description":"Amount paid using this payment type. Only differs from total amount paid in case of split payments.","type":"string","x-wix-docs":{"exposure":"PUBLIC","decimalValue":{"maxScale":2}}},"method":{"title":"method","description":"Payment method.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"providerTransactionId":{"title":"providerTransactionId","description":"Transaction ID.\nSee [Cashier API](https://dev.wix.com/api/rest/wix-cashier/payments/transaction) for more details.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Payment","description":""},"com.wixpress.restaurants.orders.v3.Payment.Type":{"type":"string","description":"","title":"Type","enum":["UNSPECIFIED_PAYMENT_TYPE","CASH","CREDIT","DELIVERY_CLUB","DELIVERY_COM","BITPAY","CELLARIX","BITSOFGOLD","MULTIPASS","TENBIS","PAYPAL","MYSODEXO","WIX_PAYMENTS"]},"com.wixpress.restaurants.orders.v3.Fulfillment":{"type":"object","properties":{"type":{"title":"type","description":"Fulfillment type.","type":"string","$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.Fulfillment.Type","x-wix-docs":{"exposure":"PUBLIC"}},"promisedTime":{"title":"promisedTime","description":"Latest delivery time promised by the restaurant.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"asap":{"title":"asap","description":"Whether the order should be fulfilled as soon as possible. Defaults to `true`.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Fulfillment","description":"","oneOf":[{"description":"","summary":"details","$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.Fulfillment.details"}]},"com.wixpress.restaurants.orders.v3.Fulfillment.details":{"type":"object","title":"details","properties":{"deliveryDetails":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.DeliveryDetails","summary":"deliveryDetails","description":"Delivery details.","x-wix-docs":{"exposure":"PUBLIC"}},"pickupDetails":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.PickupDetails","summary":"pickupDetails","description":"Pickup details.","x-wix-docs":{"exposure":"PUBLIC"}},"dineInDetails":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.DineInDetails","summary":"dineInDetails","description":"Dine-in details","x-wix-docs":{"exposure":"PUBLIC"}}}},"com.wixpress.restaurants.orders.v3.Fulfillment.Type":{"type":"string","description":"","title":"Type","enum":["UNSPECIFIED_FULFILLMENT_TYPE","PICKUP","DELIVERY","DINE_IN"]},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"title":"value","description":"","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BoolValue","description":""},"com.wixpress.restaurants.orders.v3.DeliveryDetails":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.DeliveryAddress","summary":"address","description":"Delivery address.","x-wix-docs":{"exposure":"PUBLIC"}},"pickupInfo":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.DeliveryDetails.PickupInfo","summary":"pickupInfo","description":"Information about the delivery pickup.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"DeliveryDetails","description":"","oneOf":[{"description":"","summary":"provider","$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.DeliveryDetails.provider"}]},"com.wixpress.restaurants.orders.v3.DeliveryDetails.provider":{"type":"object","title":"provider","properties":{"restaurant":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.DeliveryDetails.Restaurant","summary":"restaurant","description":"Delivery through the restaurant.","x-wix-docs":{"exposure":"PUBLIC"}},"externalProvider":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.DeliveryDetails.ExternalProvider","summary":"externalProvider","description":"Delivery through an external provider.","x-wix-docs":{"exposure":"PUBLIC"}}}},"com.wixpress.restaurants.orders.v3.DeliveryAddress":{"type":"object","properties":{"formatted":{"title":"formatted","description":"Formatted delivery address.","maxLength":250,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"country":{"title":"country","description":"Country.","maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"city":{"title":"city","description":"City name.","maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"street":{"title":"street","description":"Street name.","maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"streetNumber":{"title":"streetNumber","description":"Street number.","maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"apt":{"title":"apt","description":"Apartment number.","maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"floor":{"title":"floor","description":"Floor.","maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"entrance":{"title":"entrance","description":"Entrance.","maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"zipCode":{"title":"zipCode","description":"ZIP/postal code.","maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"countryCode":{"title":"countryCode","description":"Country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.","format":"COUNTRY","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"onArrival":{"title":"onArrival","description":"Special delivery instructions upon arrival to the address.","type":"string","$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.DeliveryAddress.OnArrival","x-wix-docs":{"exposure":"PUBLIC"}},"approximate":{"title":"approximate","description":"Whether an approximate address is used. Defaults to `false`. In case of `false` a house number is required.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"comment":{"title":"comment","description":"Delivery Instructions added by the customer.","maxLength":500,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"location":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.DeliveryAddressLocation","summary":"location","description":"Geo coordinates of the address.","x-wix-docs":{"exposure":"PUBLIC"}},"addressLine2":{"title":"addressLine2","description":"Address Line 2.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"subdivision":{"title":"subdivision","description":"Subdivision. Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2).","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"DeliveryAddress","description":""},"com.wixpress.restaurants.orders.v3.DeliveryAddress.OnArrival":{"type":"string","description":"","title":"OnArrival","enum":["UNSPECIFIED_ON_ARRIVAL_TYPE","BUZZ_DOOR","CALL_ME"]},"com.wixpress.restaurants.orders.v3.DeliveryAddressLocation":{"type":"object","properties":{"latitude":{"title":"latitude","description":"Address latitude.","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC"}},"longitude":{"title":"longitude","description":"Address longitude.","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"DeliveryAddressLocation","description":""},"google.protobuf.DoubleValue":{"type":"object","properties":{"value":{"title":"value","description":"","type":"number","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"DoubleValue","description":""},"com.wixpress.restaurants.orders.v3.DeliveryDetails.Restaurant":{"type":"object","properties":{"fee":{"title":"fee","description":"Delivery fee.","type":"string","x-wix-docs":{"exposure":"PUBLIC","decimalValue":{"maxScale":2}}}},"title":"Restaurant","description":""},"com.wixpress.restaurants.orders.v3.DeliveryDetails.ExternalProvider":{"type":"object","properties":{"id":{"title":"id","description":"ID of the external delivery provider.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"name":{"title":"name","description":"Name of the external delivery provider.","readOnly":true,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"customerFee":{"title":"customerFee","description":"Delivery fee charged to the customer.","type":"string","x-wix-docs":{"exposure":"PUBLIC","decimalValue":{"maxScale":2}}},"commission":{"title":"commission","description":"Fee paid by the restaurant to the external delivery provider.","readOnly":true,"type":"string","x-wix-docs":{"exposure":"PUBLIC","decimalValue":{"maxScale":2}}},"pickupTime":{"title":"pickupTime","description":"Order pickup time.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"dropOffTime":{"title":"dropOffTime","description":"Order drop off time.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ExternalProvider","description":""},"com.wixpress.restaurants.orders.v3.DeliveryDetails.PickupInfo":{"type":"object","properties":{"windowStartTime":{"title":"windowStartTime","description":"When a delivery is ready to be picked up. This is the start time of the pickup window.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"windowEndTime":{"title":"windowEndTime","description":"When a delivery must be picked up by. This is the end time of the pickup window.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PickupInfo","description":""},"com.wixpress.restaurants.orders.v3.DeliveryDetails.DropOffInfo":{"type":"object","properties":{"contactless":{"title":"contactless","description":"Whether the order is delivered contactless.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"DropOffInfo","description":""},"com.wixpress.restaurants.orders.v3.PickupDetails":{"type":"object","properties":{"fee":{"title":"fee","description":"Pickup fee charged to the customer.","type":"string","x-wix-docs":{"exposure":"PUBLIC","decimalValue":{"maxScale":2}}},"curbside":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.PickupDetails.Curbside","summary":"curbside","description":"Curbside pickup method","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PickupDetails","description":""},"com.wixpress.restaurants.orders.v3.PickupDetails.Curbside":{"type":"object","properties":{"info":{"title":"info","description":"Additional information for curbside pickup.","minLength":0,"maxLength":50,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Curbside","description":""},"com.wixpress.restaurants.orders.v3.DineInDetails":{"type":"object","properties":{"label":{"title":"label","description":"Label of dine-in information added by the restaurant, e.g. `table` or `booth`.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"value":{"title":"value","description":"Value of dine-in information added by the restaurant, e.g. `#6`.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"DineInDetails","description":""},"com.wixpress.restaurants.orders.v3.Customer":{"type":"object","properties":{"firstName":{"title":"firstName","description":"First name.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"lastName":{"title":"lastName","description":"Last name.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"phone":{"title":"phone","description":"Phone number.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"email":{"title":"email","description":"Email address.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"contactId":{"title":"contactId","description":"Customer's contact ID.\nSee [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4) for more details.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Customer","description":"Customer information.","oneOf":[{"description":"","summary":"id","$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.Customer.id"}]},"com.wixpress.restaurants.orders.v3.Customer.id":{"type":"object","title":"id","properties":{"memberId":{"title":"memberId","description":"Member ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"visitorId":{"title":"visitorId","description":"Visitor ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}}},"com.wixpress.restaurants.orders.v3.Totals":{"type":"object","properties":{"subtotal":{"title":"subtotal","description":"Order subtotal. Calculated by substracting delivery fee, tax and discount from order total.","type":"string","x-wix-docs":{"exposure":"PUBLIC","decimalValue":{"maxScale":2}}},"total":{"title":"total","description":"Total order price.","type":"string","x-wix-docs":{"exposure":"PUBLIC","decimalValue":{"maxScale":2}}},"delivery":{"title":"delivery","description":"Total delivery fees charged to the customer.","type":"string","x-wix-docs":{"exposure":"PUBLIC","decimalValue":{"maxScale":2}}},"tax":{"title":"tax","description":"Total tax.","type":"string","x-wix-docs":{"exposure":"PUBLIC","decimalValue":{"maxScale":2}}},"discount":{"title":"discount","description":"Total discount amount.","type":"string","x-wix-docs":{"exposure":"PUBLIC","decimalValue":{"maxScale":2}}},"loyaltySavings":{"title":"loyaltySavings","description":"Total amount saved through the Wix Loyalty program.","type":"string","x-wix-docs":{"exposure":"PUBLIC","decimalValue":{"maxScale":2}}},"quantity":{"title":"quantity","description":"Total number of line items.","minimum":0,"readOnly":true,"type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"tip":{"title":"tip","description":"Total tip.","type":"string","x-wix-docs":{"exposure":"PUBLIC","decimalValue":{"maxScale":2}}}},"title":"Totals","description":""},"com.wixpress.restaurants.orders.v3.ServiceFee":{"type":"object","properties":{"ruleId":{"title":"ruleId","description":"The service fee's unique id.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"name":{"title":"name","description":"The service fee's name.","readOnly":true,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"fee":{"$ref":"#/components/schemas/wix.common.Money","summary":"fee","description":"The service fee's fee as Money.","x-wix-docs":{"exposure":"PUBLIC"}},"tax":{"$ref":"#/components/schemas/wix.common.Money","summary":"tax","description":"The service fee's tax as Money.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ServiceFee","description":""},"wix.common.Money":{"type":"object","properties":{"value":{"title":"value","description":"Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative.","format":"DECIMAL_VALUE","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"currency":{"title":"currency","description":"Currency code. Must be valid ISO 4217 currency code (e.g., USD).","format":"CURRENCY","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"formattedValue":{"title":"formattedValue","description":"Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Money","description":"Money.\nDefault format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003."},"com.wixpress.restaurants.orders.v3.Activity":{"type":"object","properties":{"timestamp":{"title":"timestamp","description":"Activity timestamp.","readOnly":true,"type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"message":{"title":"message","description":"Optional message added during order activity.","maxLength":1000,"readOnly":true,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Activity","description":""},"com.wixpress.restaurants.orders.v3.ChannelInfo":{"type":"object","properties":{"type":{"title":"type","description":"","type":"string","$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.ChannelInfo.Type","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ChannelInfo","description":""},"com.wixpress.restaurants.orders.v3.ChannelInfo.Type":{"type":"string","description":"","title":"Type","enum":["UNSPECIFIED_CHANNEL_TYPE","WEB","MOBILE_WEB","MOBILE","CALL_CENTER","FACEBOOK","TPA"]},"com.wixpress.restaurants.orders.v3.LoyaltyInfo":{"type":"object","properties":{"rewardId":{"title":"rewardId","description":"Associated Wix Loyalty reward ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"appliedAmount":{"title":"appliedAmount","description":"Amount saved redeeming Wix Loyalty reward.","type":"string","x-wix-docs":{"exposure":"PUBLIC","decimalValue":{"maxScale":2}}},"redeemedPoints":{"title":"redeemedPoints","description":"Wix Loyalty points redeemed.","minimum":0,"readOnly":true,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"transactionId":{"title":"transactionId","description":"Associated Wix Loyalty transaction ID.","format":"GUID","readOnly":true,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"estimatedAccountBalance":{"title":"estimatedAccountBalance","description":"Wix Loyalty estimated account point balance.\nEqual to the sum of earned and adjusted points minus redeemed points.\nThe estimated point balance is the value before the order is completed. Following the purchase, the point balance is updated.","minimum":0,"readOnly":true,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"estimatedPointsEarned":{"title":"estimatedPointsEarned","description":"Wix Loyalty estimated total earned points.\nThe estimated total earned points is the value before the order is completed. Following the purchase, the total is updated.","minimum":0,"readOnly":true,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"rewardRevision":{"title":"rewardRevision","description":"Associated Wix Loyalty reward revision number, which increments by 1 each time the loyalty account is updated.\n\nTo prevent conflicting changes, the current revision must be passed when updating the loyalty account.\nIgnored when creating an account.","readOnly":true,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"LoyaltyInfo","description":""},"com.wixpress.restaurants.orders.v3.PosInfo":{"type":"object","properties":{"externalProvider":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.PosInfo.ExternalProvider","summary":"externalProvider","description":"","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PosInfo","description":""},"com.wixpress.restaurants.orders.v3.PosInfo.Error":{"type":"object","properties":{"code":{"title":"code","description":"Error code","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"message":{"title":"message","description":"Error message","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"params":{"title":"params","description":"Error params","type":"object","format":"map","properties":{"key:value":{"type":"string","description":"\"key\" of type string, \"value\" of type string","title":"key:value"}},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Error","description":""},"com.wixpress.restaurants.orders.v3.PosInfo.ExternalProvider":{"type":"object","properties":{"id":{"title":"id","description":"ID of the external provider.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"orderId":{"title":"orderId","description":"ID of the order in the external provider.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"success":{"title":"success","description":"Order creation success","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"errors":{"title":"errors","description":"Order creation errors","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.PosInfo.Error"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ExternalProvider","description":""},"com.wixpress.restaurants.orders.bm.GetTotalActiveOrdersRequest":{"type":"object","properties":{"locationId":{"title":"locationId","description":"filter response to a specific location, otherwise return totals for all locations.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"organizationId":{"title":"organizationId","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"promisedTimeNew":{"title":"promisedTimeNew","description":"Order delivery date and time for filtering new orders count, Must include a `gte:` or `lte:` prefix, for example: `gte:2021-10-26T12:48:15Z`.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"promisedTimeInProgress":{"title":"promisedTimeInProgress","description":"Order delivery date and time for filtering new orders count, Must include a `gte:` or `lte:` prefix, for example: `gte:2021-10-26T12:48:15Z`.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetTotalActiveOrdersRequest","description":""},"com.wixpress.restaurants.orders.bm.GetTotalActiveOrdersResponse":{"type":"object","properties":{"totals":{"title":"totals","description":"list of locationId's mapped to the total number of orders.","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.bm.LocationToAmount"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetTotalActiveOrdersResponse","description":""},"com.wixpress.restaurants.orders.bm.LocationToAmount":{"type":"object","properties":{"locationId":{"title":"locationId","description":"","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"locationName":{"title":"locationName","description":"","maxLength":150,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"totalNew":{"title":"totalNew","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"totalInProgress":{"title":"totalInProgress","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"LocationToAmount","description":""},"com.wixpress.restaurants.orders.v3.NewOrder":{"type":"object","properties":{"order":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.Order","summary":"order","description":"New order.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"NewOrder","description":""},"com.wixpress.restaurants.orders.v3.GetOrderRequest":{"type":"object","properties":{"id":{"title":"id","description":"ID of the order to retrieve.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"fieldMask":{"title":"fieldMask","description":"Set of fields to retrieve.\nFields that aren't included in `fieldmaks.paths` are ignored.\nSee [the article about field masks](https://dev.wix.com/api/rest/restaurants/orders/supported-field-masks)\nfor more details.","$ref":"#/components/schemas/google.protobuf.FieldMask","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetOrderRequest","description":""},"google.protobuf.FieldMask":{"type":"object","properties":{"paths":{"title":"paths","description":"","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"FieldMask","description":""},"com.wixpress.restaurants.orders.v3.GetOrderResponse":{"type":"object","properties":{"order":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.Order","summary":"order","description":"Retrieved order.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetOrderResponse","description":""},"com.wixpress.restaurants.orders.v3.ListOrdersRequest":{"type":"object","properties":{"fieldMask":{"title":"fieldMask","description":"Set of fields to retrieve.\nFields that aren't included in `fieldmaks.paths` are ignored.\nSee [the article about field masks](https://dev.wix.com/api/rest/restaurants/orders/supported-field-masks)\nfor more details.","$ref":"#/components/schemas/google.protobuf.FieldMask","x-wix-docs":{"exposure":"PUBLIC"}},"status":{"title":"status","description":"Order status. Currently, it is not possible to filter by status `FULFILLED`.","type":"string","$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.Status","x-wix-docs":{"exposure":"PUBLIC"}},"createdDate":{"title":"createdDate","description":"Order creation date and time. Must include a `gte:` or `lte:` prefix, for example: `gte:2021-10-26T12:48:15Z`.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"delivered":{"title":"delivered","description":"Whether the order has been delivered.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"locationIds":{"title":"locationIds","description":"Location filter. Pass an array of location IDs to return orders with any of the provided locations.","format":"GUID","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}},"sort":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.Sort","summary":"sort","description":"Sorting options.","x-wix-docs":{"exposure":"PUBLIC"}},"limit":{"title":"limit","description":"Number of orders to return. The minimum limit is 1, the maximum 1000.","minimum":1,"maximum":1000,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListOrdersRequest","description":""},"com.wixpress.restaurants.orders.v3.Sort":{"type":"object","properties":{"fieldName":{"title":"fieldName","description":"Field to sort by.","type":"string","$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.Sort.FieldName","x-wix-docs":{"exposure":"PUBLIC"}},"order":{"title":"order","description":"Sort order.","type":"string","$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.Sort.Order","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Sort","description":""},"com.wixpress.restaurants.orders.v3.Sort.FieldName":{"type":"string","description":"","title":"FieldName","enum":["CREATED_DATE","UPDATED_DATE","PROMISED_TIME"]},"com.wixpress.restaurants.orders.v3.Sort.Order":{"type":"string","description":"","title":"Order","enum":["ASC","DESC"]},"wix.common.CursorPaging":{"type":"object","properties":{"limit":{"title":"limit","description":"Maximum number of items to return in the results.","minimum":0,"maximum":100,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"cursor":{"title":"cursor","description":"Pointer to the next or previous page in the list of results.\n\nPass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CursorPaging","description":""},"com.wixpress.restaurants.orders.v3.ListOrdersResponse":{"type":"object","properties":{"orders":{"title":"orders","description":"List of retrieved orders.","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.Order"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListOrdersResponse","description":""},"wix.common.PagingMetadataV2":{"type":"object","properties":{"count":{"title":"count","description":"Number of items returned in the response.","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"offset":{"title":"offset","description":"Offset that was requested.","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"total":{"title":"total","description":"Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set.","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"tooManyToCount":{"title":"tooManyToCount","description":"Flag that indicates the server failed to calculate the `total` field.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"cursors":{"$ref":"#/components/schemas/wix.common.Cursors","summary":"cursors","description":"Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PagingMetadataV2","description":""},"wix.common.Cursors":{"type":"object","properties":{"next":{"title":"next","description":"Cursor string pointing to the next page in the list of results.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"prev":{"title":"prev","description":"Cursor pointing to the previous page in the list of results.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Cursors","description":""},"com.wixpress.restaurants.orders.v3.AcceptOrderRequest":{"type":"object","properties":{"id":{"title":"id","description":"ID of the order to mark as `ACCEPTED`.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"message":{"title":"message","description":"Message when accepting the order.","maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"AcceptOrderRequest","description":"","oneOf":[{"description":"","summary":"deliveryTime","$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.AcceptOrderRequest.deliveryTime"}]},"com.wixpress.restaurants.orders.v3.AcceptOrderRequest.deliveryTime":{"type":"object","title":"deliveryTime","properties":{}},"com.wixpress.restaurants.orders.v3.AcceptOrderResponse":{"type":"object","properties":{"order":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.Order","summary":"order","description":"Accepted order.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"AcceptOrderResponse","description":""},"com.wixpress.restaurants.orders.v3.OrderAccepted":{"type":"object","properties":{"order":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.Order","summary":"order","description":"Accepted order.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"OrderAccepted","description":""},"com.wixpress.restaurants.orders.v3.CancelOrderRequest":{"type":"object","properties":{"id":{"title":"id","description":"ID of the order to mark as `CANCELED`.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"message":{"title":"message","description":"Message when canceling the order.","maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CancelOrderRequest","description":""},"com.wixpress.restaurants.orders.v3.CancelOrderResponse":{"type":"object","properties":{"order":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.Order","summary":"order","description":"Canceled order.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CancelOrderResponse","description":""},"com.wixpress.restaurants.orders.v3.OrderCanceled":{"type":"object","properties":{"order":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.Order","summary":"order","description":"Canceled order.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"OrderCanceled","description":""},"com.wixpress.restaurants.orders.v3.FulfillOrderRequest":{"type":"object","properties":{"id":{"title":"id","description":"ID of the order to mark as `FULFILLED`.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"FulfillOrderRequest","description":""},"com.wixpress.restaurants.orders.v3.FulfillOrderResponse":{"type":"object","properties":{"order":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.Order","summary":"order","description":"Fulfilled order.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"FulfillOrderResponse","description":""},"com.wixpress.restaurants.orders.v3.OrderFulfilled":{"type":"object","properties":{"order":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.Order","summary":"order","description":"Fulfilled order.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"OrderFulfilled","description":""},"com.wixpress.restaurants.orders.v3.CountOrdersRequest":{"type":"object","properties":{"restaurantLocationId":{"title":"restaurantLocationId","description":"Count orders only for a specific restaurant location","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"query":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.CountOrdersQuery","summary":"query","description":"Limit the count only for orders that match the query","x-wix-docs":{"exposure":"PUBLIC"}},"locationId":{"title":"locationId","description":"Count orders only for a specific OS location ID","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CountOrdersRequest","description":""},"com.wixpress.restaurants.orders.v3.CountOrdersQuery":{"type":"object","properties":{"status":{"title":"status","description":"Required - filter orders count by status. Supported values: NEW, ACCEPTED","type":"string","$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.Status","x-wix-docs":{"exposure":"PUBLIC"}},"promisedTime":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.CountOrdersQuery.DateRangeFilter","summary":"promisedTime","description":"Required - filter orders count by fulfillment promised time. (Latest delivery time promised by the restaurant)\nMaximum supported range is up to 30 days.\nNOTE: Count is a slow operation, for better performance request smaller time ranges.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CountOrdersQuery","description":""},"com.wixpress.restaurants.orders.v3.CountOrdersQuery.DateRangeFilter":{"type":"object","properties":{"startTime":{"title":"startTime","description":"Filter by date range, starting from given timestamp","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"endTime":{"title":"endTime","description":"Filter by date range, ending by a given timestamp","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"DateRangeFilter","description":""},"com.wixpress.restaurants.orders.v3.CountOrdersResponse":{"type":"object","properties":{"count":{"title":"count","description":"Number of orders count that match the query","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CountOrdersResponse","description":""},"com.wixpress.restaurants.orders.v3.NotifyOrderEventRequest":{"type":"object","properties":{"id":{"title":"id","description":"Order ID.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"msid":{"title":"msid","description":"Metasite id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"eventType":{"title":"eventType","description":"Notification event type","type":"string","$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.NotifyOrderEventRequest.EventType","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"NotifyOrderEventRequest","description":""},"com.wixpress.restaurants.orders.v3.NotifyOrderEventRequest.EventType":{"type":"string","description":"","title":"EventType","enum":["UNKNOWN","CREATED","ACCEPTED","CANCELED","FULFILLED"]},"google.protobuf.Empty":{"type":"object","properties":{},"title":"Empty","description":""},"com.wixpress.restaurants.orders.v3.GetOrderByMsidRequest":{"type":"object","properties":{"id":{"title":"id","description":"Order ID.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"msid":{"title":"msid","description":"Metasite id","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"fieldMask":{"title":"fieldMask","description":"Controls what data is returned in the response","$ref":"#/components/schemas/google.protobuf.FieldMask","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetOrderByMsidRequest","description":""},"com.wixpress.restaurants.orders.v3.GetOrderByMsidResponse":{"type":"object","properties":{"order":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.Order","summary":"order","description":"Order data.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetOrderByMsidResponse","description":""},"com.wixpress.restaurants.orders.v3.ListOrdersByMsidRequest":{"type":"object","properties":{"fieldMask":{"title":"fieldMask","description":"Controls what data is returned in the response.","$ref":"#/components/schemas/google.protobuf.FieldMask","x-wix-docs":{"exposure":"PUBLIC"}},"status":{"title":"status","description":"Order status to filter by. Currently Status Fulfilled is not supported","type":"string","$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.Status","x-wix-docs":{"exposure":"PUBLIC"}},"createdDate":{"title":"createdDate","description":"Created date of the order epoch time.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"delivered":{"title":"delivered","description":"","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"sort":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.Sort","summary":"sort","description":"Sorting of Orders in response. Default \"CREATED_DATE:ASC\"","x-wix-docs":{"exposure":"PUBLIC"}},"limit":{"title":"limit","description":"limit of records - min: 1 max: 2000","minimum":1,"maximum":2000,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"msid":{"title":"msid","description":"Metasite id","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListOrdersByMsidRequest","description":""},"com.wixpress.restaurants.orders.v3.ListOrdersByMsidResponse":{"type":"object","properties":{"orders":{"title":"orders","description":"Order data.","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.restaurants.orders.v3.Order"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListOrdersByMsidResponse","description":""},"com.wixpress.restaurants.orders.v3.NotifyOrderEventResponse":{"type":"object","properties":{},"title":"NotifyOrderEventResponse","description":""}}},"title":"Order","description":"","fqdn":"wix.restaurants.v3.order"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About Wix Restaurants Orders\n\n> **Note:** This API only works with the original Wix Restaurants Orders app. Call [GetAppInstance](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::5a829a3f-423e-484e-80c5-b70320bf9383slug::get-app-instance*fallback::https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/get-app-instance) to confirm that the app named “restaurants_orders” is installed on the site.\n\nWith Wix Restaurants Orders, site owners can retrieve orders and update their statuses. They can also receive a notification when a new order has been placed.\n\nThe Orders API allows your app to:\n\n* Retrieve orders\n* Mark orders as **accepted**, **fulfilled**, and **canceled**\n* Listen to domain events\n\n## Terminology\n\n* **Catalog:** All **menus**.\n* **Line Item:** Any **dish** or **dish option** defined in the catalog.\n* **Dish Option:** Any **extra** that you can add to a dish, any **size** of the dish, or any **deselection** that you can remove from the dish.\n* **Discount:** A price reduction for an **item** or the **order**. The discount can be an amount, a percentage or free delivery. Discounts may depend on entering a coupon code.\n* **Order Statuses**:\n * **Pending:** The order has been placed by the customer, but the payment or validation checks have not cleared yet.\n\n > **Note:** Site owners can't see **pending** orders in their dashboard.\n * **New:** The order has passed validation checks and the payment has cleared, but the site owners have not **accepted** or **canceled** the order yet.\n * **Accepted:** The site owners have agreed to fulfill the order.\n > **Note:** Site owners can set up an automation in the dashboard to immediately accept every **new** order.\n * **Canceled:** The site owners have decided not to fulfill the order or to mark an already **fulfilled** order as problematic.\n * **Fulfilled:** The order has been successfully distributed.\n\n## Limitations\n\n* **Discounts:** Percentage discounts can only be applied to an item but not the entire order.\n* Currently the Restaurants Orders API doesn’t include create functionality. You can update order statuses and listen to domain events.\n"},{"displayName":"Example Flow","slugifyName":"example-flow","content":"# Sample Use Case & Flow: Wix Restaurants Orders\n\nThis article shares a possible use case your app could support, as well as an example flow. \nYou're certainly not limited to this use case, but it can be a helpful jumping off point \nas you plan your app's implementation.\n\n## Sync Orders Placed on Wix Restaurants with an External POS\n\nIn order to enable site owners to sync their external POS with Wix Restaurants Orders \ndata, your app will need to retrieve each new order that is placed in Wix Restaurants. \nThen you can create a mapping to keep the order statuses synced. \n\n1. Sign up for the [New Order Domain Event](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::0f61c670-a569-4683-a32e-db82300d1471slug::new-order*fallback::https://dev.wix.com/api/rest/wix-restaurants/orders/new-order-webhook).\n2. Create a mapping between Wix Restaurants and the external POS. Store the mapping on your servers.\n3. Get notified when a new order has been placed on Wix Restaurants and add it to the mapping.\n4. Add the order to the external POS.\n\n > **Note:** Make sure to include both Wix Restaurants `orderId` and external order ID in the mapping.\n5. Change the order status on Wix Restaurants according to events in the external POS. Use the [Accept Order](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::0f61c670-a569-4683-a32e-db82300d1471slug::accept-order*fallback::https://dev.wix.com/api/rest/wix-restaurants/orders/accept-order), [Fulfill Order](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::0f61c670-a569-4683-a32e-db82300d1471slug::fulfill-order*fallback::https://dev.wix.com/api/rest/wix-restaurants/orders/fulfill-order), and [Cancel Order](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::0f61c670-a569-4683-a32e-db82300d1471slug::cancel-order*fallback::https://dev.wix.com/api/rest/wix-restaurants/orders/cancel-order) endpoints.\n"},{"displayName":"Supported Field Masks","slugifyName":"supported-field-masks","content":"# Field Masks\n\nThe [List Orders](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::0f61c670-a569-4683-a32e-db82300d1471slug::list-orders*fallback::https://dev.wix.com/api/rest/wix-restaurants/orders/list-orders) \nand [Get Order](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::0f61c670-a569-4683-a32e-db82300d1471slug::get-order*fallback::https://dev.wix.com/api/rest/wix-restaurants/orders/get-order) endpoints \nallow you to return a partial `order` object\nincluding only the fields you request.\nTo do this, you can use projected fields in the `fieldMask.paths` array in your request.\n\n## Supported Projected Fields\n\nThe following fields can be returned in a partial object\nby specifying them in `fieldMask.paths`:\n\n> **Note:**\n> `id` and `revision` are always returned,\n> even if you don’t include them in the `fieldMask.paths` array in your request.\n\n- `id` \n- `revision`\n- `created_date`\n- `updated_date`\n- `comment`\n- `currency`\n- `status`\n- `line_items`\n- `discounts` \n- `payments`\n- `activities` \n- `channel_info`\n- `channel_info.type` \n- `coupon.code`\n- `coupon.id`\n- `fulfillment` \n- `fulfillment.type`\n- `fulfillment.promised_time`\n- `fulfillment.asap`\n- `fulfillment.delivery_details`\n- `fulfillment.delivery_details.charge`\n- `fulfillment.delivery_details.address`\n- `fulfillment.delivery_details.address.formatted`\n- `fulfillment.delivery_details.address.country`\n- `fulfillment.delivery_details.address.city`\n- `fulfillment.delivery_details.address.street`\n- `fulfillment.delivery_details.address.street_number`\n- `fulfillment.delivery_details.address.apt`\n- `fulfillment.delivery_details.address.floor`\n- `fulfillment.delivery_details.address.entrance`\n- `fulfillment.delivery_details.address.zip_code`\n- `fulfillment.delivery_details.address.country_code`\n- `fulfillment.delivery_details.address.approximate`\n- `fulfillment.delivery_details.address.comment`\n- `fulfillment.delivery_details.address.address_line2`\n- `fulfillment.delivery_details.address.on_arrival`\n- `fulfillment.delivery_details.address.location`\n- `fulfillment.delivery_details.address.location.latitude`\n- `fulfillment.delivery_details.address.location.longitude` \n- `fulfillment.pickup_details`\n- `fulfillment.pickup_details.fee`\n- `fulfillment.pickup_details.curbside`\n- `fulfillment.pickup_details.curbside.info`\n- `fulfillment.dine_in_details`\n- `fulfillment.dine_in_details.label`\n- `fulfillment.dine_in_details.value`\n- `customer`\n- `customer.first_name`\n- `customer.last_name`\n- `customer.phone`\n- `customer.email`\n- `customer.contact_id`\n- `customer.member_id`\n- `customer.visitor_id`\n- `totals` \n- `totals.subtotal`\n- `totals.total`\n- `totals.delivery`\n- `totals.tax`\n- `totals.quantity`\n- `totals.loyalty_savings`\n- `totals.tip`\n- `loyalty_info`\n- `loyalty_info.reward_id`\n- `loyalty_info.applied_amount`\n- `loyalty_info.redeemed_points`\n- `loyalty_info.transaction_id`\n- `loyalty_info.estimated_account_balance`\n- `loyalty_info.estimated_points_earned`\n- `loyalty_info.reward_revision`\n"}]},"reviewStatus":"APPROVED","isLocked":true}

List Orders

Permission Scopes