Creates an event for the specified restaurants that indicates a reason for those restaurants to be offline.
643 matches
95 actions
Just Eat UK
95 actions
- Accept orderPUTv1.0.0
- Acceptance requestedPOSTv1.0.0
- Add reason and comments to the responsePUTv1.0.0
- Add restaurants to an existing delivery poolPUTv1.0.0
- Attempted delivery query resolvedPUTv1.0.0
- Cancel orderPUTv1.0.0
- Complete orderPOSTv1.0.0
- Create a new delivery poolPOSTv1.0.0
- Create Compensation requestsPOSTv1.0.0
- Create consumerPOSTv1.0.0
- Create Offline EventPOSTv1.0.0
- Create or update a menuPUTv1.0.0
- Create or Update Restaurant FeesPUTv1.0.0
- Create or update service timesPUTv1.0.0
- Create orderPOSTv1.0.0
- Customer Requested RedeliveryPUTv1.0.0
- Delete a delivery poolDELETEv1.0.0
- Delete Offline EventDELETEv1.0.0
- Delivery Attempt FailedPOSTv1.0.0
- Delivery Attempt FailedPUTv1.0.0
- Driver Assigned to DeliveryPUTv1.0.0
- Driver at delivery addressPUTv1.0.0
- Driver at restaurantPUTv1.0.0
- Driver has delivered orderPUTv1.0.0
- Driver LocationPUTv1.0.0
- Driver on their way to delivery addressPUTv1.0.0
- Get all availabilitiesGETv1.0.0
- Get all categoriesGETv1.0.0
- Get all category item IDsGETv1.0.0
- Get all menu item deal groupsGETv1.0.0
- Get all menu item modifier groupsGETv1.0.0
- Get all menu item variationsGETv1.0.0
- Get all menu itemsGETv1.0.0
- Get an individual delivery poolGETv1.0.0
- Get auto-completed search termsGETv1.0.0
- Get availability for pickupGETv1.0.0
- Get Available Fulfilment TimesGETv1.0.0
- Get channel subscriptions for a given consumer's communication preference typeGETv1.0.0
- Get CheckoutGETv1.0.0
- Get claimsGETv1.0.0
- Get communication preferencesGETv1.0.0
- Get consumers detailsGETv1.0.0
- Get delivery estimateGETv1.0.0
- Get order claimGETv1.0.0
- Get product catalogueGETv1.0.0
- Get restaurant delivery feesGETv1.0.0
- Get Restaurant FeesGETv1.0.0
- Get restaurants by locationGETv1.0.0
- Get restaurants by postcodeGETv1.0.0
- Get service timesGETv1.0.0
- Get the restaurant's delivery and collection lead timesGETv1.0.0
- Get your delivery poolsGETv1.0.0
- Ignore orderPUTv1.0.0
- late order compensation query, restaurant response requiredPOSTv1.0.0
- late order query, restaurant response requiredPOSTv1.0.0
- Mark order as ready for collectionPOSTv1.0.0
- Menu ingestion completePOSTv1.0.0
- Modify a delivery poolPATCHv1.0.0
- Order acceptedPOSTv1.0.0
- Order cancelledPOSTv1.0.0
- Order Eligible For Restaurant CompensationPOSTv1.0.0
- Order ready for pickupPUTv1.0.0
- Order ready for preparation (async)POSTv1.0.0
- Order ready for preparation (sync)POSTv1.0.0
- Order rejectedPOSTv1.0.0
- Order requires delivery acceptancePUTv1.0.0
- Order time updatedPOSTv1.0.0
- Reject orderPUTv1.0.0
- Remove restaurants from a delivery poolDELETEv1.0.0
- Remove subscription of a specific communication preference channelDELETEv1.0.0
- Replace an existing delivery poolPUTv1.0.0
- Request Redelivery of the OrderPOSTv1.0.0
- Response to Late Order Update RequestPOSTv1.0.0
- Restaurant Offline StatusPUTv1.0.0
- Restaurant Online StatusPUTv1.0.0
- Search restaurantsGETv1.0.0
- Send to POS failedPOSTv1.0.0
- Set availability for pickupPUTv1.0.0
- Set ETA for pickupPUTv1.0.0
- Set only the channel subscriptions for a given consumer's communication preference typePUTv1.0.0
- Set the delivery pools daily start and end timesPUTv1.0.0
- Submit a restaurant response for the claimPOSTv1.0.0
- Subscribe to a specific communication preference channelPOSTv1.0.0
- Update CheckoutPATCHv1.0.0
- Update late order compensation request with Restaurant responsePOSTv1.0.0
- Update order ETAPUTv1.0.0
- Update order with delivered detailsPUTv1.0.0
- Update order with driver assigned detailsPUTv1.0.0
- Update order with driver at delivery address detailsPUTv1.0.0
- Update order with driver at restaurant detailsPUTv1.0.0
- Update order with driver on its way detailsPUTv1.0.0
- Update order with driver unassigned detailsPUTv1.0.0
- Update the driver's current locationPUTv1.0.0
- Update the driver's estimated time to arrive at the RestaurantPUTv1.0.0
- Update the restaurant's delivery and collection lead timesPUTv1.0.0
E-commerce/Just Eat UK
Create Offline Event
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
{
"type": "object",
"properties": {
"X-JE-Requester": {
"type": "string"
},
"X-JE-User-Role": {
"type": "string",
"description": "\n- `System` : Role for an automated process action.\n- `Operations` : Role for an operations user action.\n- `Restaurant` : Role for a restaurant owner/employee user action.",
"enum": [
"System",
"Operations",
"Restaurant"
]
},
"allowRestaurantOverride": {
"type": "boolean",
"description": "Whether a restaurant should be allowed to delete this event, regardless of who raised it."
},
"category": {
"type": "string",
"description": "A free text category used to group multiple events. This field is not intended to be used by clients."
},
"duration": {
"type": "string",
"description": "Either a timespan in the HH:mm format or `untilTomorrow` (this will be the next day at 4:30 am +/- 10 minutes local time). Note if both duration and `endDate` are specified duration takes precedence."
},
"endDate": {
"type": "string",
"format": "date-time",
"description": "ISO 8601 format of the end datetime of the offline event."
},
"legacyTempOfflineType": {
"type": "string",
"description": "\n- `Unset` : Legacy value meaning online.\n- `None` : Legacy value meaning online.\n- `TempOffline` : The restaurant will go temporarily offline, typically for an undetermined amount of time (no end date).\n- `ClosedToday` : The restaurant will closed for the day and the event will end the next morning.\n- `ClosedDueToEvent` : The restaurant will go offline for an event (e.g. a holiday), these events will typically have an end time.\n- `FailedJctConnection` : The restaurant will go offline due to the POS device losing connection.\n- `NoTrOverride` : The restaurant will go offline for another reason that the restaurant cannot override.\n- `IgnoredOrders` : The restaurant will go offline due to ignoring orders.",
"enum": [
"Unset",
"None",
"TempOffline",
"ClosedToday",
"ClosedDueToEvent",
"FailedJctConnection",
"NoTrOverride",
"IgnoredOrders"
]
},
"name": {
"type": "string",
"description": "Name of the offline event to be created."
},
"reason": {
"type": "string",
"description": "The reason for creating the offline event."
},
"restaurantIds": {
"type": "string",
"description": "A comma separated list of the IDs of the restaurants to include in the offline event. No limit to the number accepted by the endpoint, but unexpected behaviour mat occur at more than 500 IDs."
},
"startDate": {
"type": "string",
"format": "date-time",
"description": "ISO 8601 format of the start datetime of the offline event."
},
"tenant": {
"type": "string"
}
},
"required": [
"X-JE-Requester",
"X-JE-User-Role",
"allowRestaurantOverride",
"name",
"reason",
"restaurantIds",
"startDate",
"tenant"
],
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
{
"type": "object",
"properties": {
"restaurantEventId": {
"type": "string",
"description": "The ID of the offline event created"
},
"restaurantIds": {
"type": "string",
"description": "A CSV of the restaurant IDs added to the offline event"
}
}
}