openapi-directory/api/just-eat.co.uk.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"contact":{"x-twitter":"JustEatUK"},"description":"<h2>Delivery Service API</h2><p>Some calls require HTTPS and an Authorization Key which will be provided by Just Eat.<p><p>The key needs to be provided in the header as follows: <b>Authorization: JE-API-KEY {Your-Key-Here}</b></p>","title":"Just Eat UK","version":"v1","x-apisguru-categories":["ecommerce"],"x-logo":{"url":"https://twitter.com/JustEatUK/profile_image?size=original"},"x-origin":[{"format":"swagger","url":"https://uk-deliveryserviceexternalapi.just-eat.co.uk:443/swagger/docs/v1","version":"2.0"}],"x-providerName":"just-eat.co.uk"},"paths":{"/Delivery/DeliverableRestaurants":{"get":{"deprecated":false,"description":"- This method requires the use of an Authorization Key.\r\n","operationId":"Delivery_DeliverableRestaurants","parameters":[{"in":"query","name":"toLat","required":false,"schema":{"type":"number","format":"double"}},{"in":"query","name":"toLon","required":false,"schema":{"type":"number","format":"double"}},{"in":"query","name":"toPostcode","required":false,"schema":{"type":"string"}},{"description":"access token","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliverableRestaurants"}},"text/json":{"schema":{"$ref":"#/components/schemas/DeliverableRestaurants"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DeliverableRestaurants"}},"text/xml":{"schema":{"$ref":"#/components/schemas/DeliverableRestaurants"}}}}},"tags":["Delivery"]}},"/Delivery/Estimate":{"get":{"deprecated":false,"description":"- This method requires the use of an Authorization Key.\r\n","operationId":"Delivery_Estimate","parameters":[{"in":"query","name":"restaurantReference","required":true,"schema":{"type":"string"}},{"in":"query","name":"toLat","required":false,"schema":{"type":"string"}},{"in":"query","name":"toLon","required":false,"schema":{"type":"string"}},{"in":"query","name":"toPostcode","required":false,"schema":{"type":"string"}},{"description":"access token","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EstimatedDeliveryTime"}},"text/json":{"schema":{"$ref":"#/components/schemas/EstimatedDeliveryTime"}},"application/xml":{"schema":{"$ref":"#/components/schemas/EstimatedDeliveryTime"}},"text/xml":{"schema":{"$ref":"#/components/schemas/EstimatedDeliveryTime"}}}}},"tags":["Delivery"]}},"/health/check":{"get":{"deprecated":false,"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthState"}},"text/json":{"schema":{"$ref":"#/components/schemas/HealthState"}},"application/xml":{"schema":{"$ref":"#/components/schemas/HealthState"}},"text/xml":{"schema":{"$ref":"#/components/schemas/HealthState"}}}}},"tags":["Health"]}},"/health/validate":{"get":{"deprecated":false,"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthState"}},"text/json":{"schema":{"$ref":"#/components/schemas/HealthState"}},"application/xml":{"schema":{"$ref":"#/components/schemas/HealthState"}},"text/xml":{"schema":{"$ref":"#/components/schemas/HealthState"}}}}},"tags":["Health"]}},"/healthcheck":{"get":{"deprecated":false,"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthState"}},"text/json":{"schema":{"$ref":"#/components/schemas/HealthState"}},"application/xml":{"schema":{"$ref":"#/components/schemas/HealthState"}},"text/xml":{"schema":{"$ref":"#/components/schemas/HealthState"}}}}},"tags":["Health"]}},"/orders/deliverystate/driverlocation":{"put":{"deprecated":false,"description":"- This method requires the use of an Authorization Key.\r\n","operationId":"Delivery_BulkDriverLocations","parameters":[{"description":"access token","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/BulkDeliveryDetails"},"type":"array"}},"text/json":{"schema":{"items":{"$ref":"#/components/schemas/BulkDeliveryDetails"},"type":"array"}},"application/xml":{"schema":{"items":{"$ref":"#/components/schemas/BulkDeliveryDetails"},"type":"array"}},"text/xml":{"schema":{"items":{"$ref":"#/components/schemas/BulkDeliveryDetails"},"type":"array"}},"application/x-www-form-urlencoded":{"schema":{"items":{"$ref":"#/components/schemas/BulkDeliveryDetails"},"type":"array"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Object"}},"text/json":{"schema":{"$ref":"#/components/schemas/Object"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Object"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Object"}}}}},"tags":["Delivery"]}},"/orders/{id}/deliverystate/atdeliveryaddress":{"put":{"deprecated":false,"description":"- This method requires the use of an Authorization Key.\r\n","operationId":"Delivery_AtDeliveryAddress","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"access token","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/DeliveryDetails"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Object"}},"text/json":{"schema":{"$ref":"#/components/schemas/Object"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Object"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Object"}}}}},"tags":["Delivery"]}},"/orders/{id}/deliverystate/atrestaurant":{"put":{"deprecated":false,"description":"- This method requires the use of an Authorization Key.\r\n","operationId":"Delivery_AtRestaurant","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"access token","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/DeliveryDetails"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Object"}},"text/json":{"schema":{"$ref":"#/components/schemas/Object"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Object"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Object"}}}}},"tags":["Delivery"]}},"/orders/{id}/deliverystate/delivered":{"put":{"deprecated":false,"description":"- This method requires the use of an Authorization Key.\r\n","operationId":"Delivery_Delivered","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"access token","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/DeliveryDetails"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Object"}},"text/json":{"schema":{"$ref":"#/components/schemas/Object"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Object"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Object"}}}}},"tags":["Delivery"]}},"/orders/{id}/deliverystate/driverassigned":{"put":{"deprecated":false,"description":"- This method requires the use of an Authorization Key.\r\n","operationId":"Delivery_DriverAssigned","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"access token","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryDriverAssignedDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/DeliveryDriverAssignedDetails"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DeliveryDriverAssignedDetails"}},"text/xml":{"schema":{"$ref":"#/components/schemas/DeliveryDriverAssignedDetails"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/DeliveryDriverAssignedDetails"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Object"}},"text/json":{"schema":{"$ref":"#/components/schemas/Object"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Object"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Object"}}}}},"tags":["Delivery"]}},"/orders/{id}/deliverystate/driverlocation":{"put":{"deprecated":false,"description":"- This method requires the use of an Authorization Key.\r\n","operationId":"Delivery_DriverLocation","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"access token","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/DeliveryDetails"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Object"}},"text/json":{"schema":{"$ref":"#/components/schemas/Object"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Object"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Object"}}}}},"tags":["Delivery"]}},"/orders/{id}/deliverystate/onitsway":{"put":{"deprecated":false,"description":"- This method requires the use of an Authorization Key.\r\n","operationId":"Delivery_OnItsWay","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"access token","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnItsWayDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/OnItsWayDetails"}},"application/xml":{"schema":{"$ref":"#/components/schemas/OnItsWayDetails"}},"text/xml":{"schema":{"$ref":"#/components/schemas/OnItsWayDetails"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/OnItsWayDetails"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Object"}},"text/json":{"schema":{"$ref":"#/components/schemas/Object"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Object"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Object"}}}}},"tags":["Delivery"]}}},"servers":[{"url":"https://uk-deliveryserviceexternalapi.just-eat.co.uk:443"}],"components":{"requestBodies":{"DeliveryDetails":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/DeliveryDetails"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DeliveryDetails"}},"text/xml":{"schema":{"$ref":"#/components/schemas/DeliveryDetails"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/DeliveryDetails"}}},"required":true}},"schemas":{"BulkDeliveryDetails":{"properties":{"Location":{"$ref":"#/components/schemas/Location"},"OrderId":{"type":"string"},"TimeStampWithUtcOffset":{"format":"date-time","type":"string"}},"type":"object"},"DeliverableRestaurant":{"properties":{"DeliveryDistanceInMetres":{"format":"int32","type":"integer"},"DeliveryDurationInSeconds":{"format":"int32","type":"integer"},"EstimatedWaitForDeliveryPickupInSeconds":{"format":"int32","type":"integer"},"Restaurant":{"$ref":"#/components/schemas/DeliveryableRestaurantLocationInfo"}},"type":"object"},"DeliverableRestaurants":{"properties":{"DeliveryLocation":{"$ref":"#/components/schemas/DeliveryLocation"},"Restaurants":{"items":{"$ref":"#/components/schemas/DeliverableRestaurant"},"type":"array"}},"type":"object"},"DeliveryDetails":{"example":{"Location":{"Accuracy":12.923,"Heading":312.29,"Latitude":51.51641,"Longitude":-0.103198,"Speed":4.12},"TimeStampWithUtcOffset":"2018-08-24T13:24:04.6852444+00:00"},"properties":{"Location":{"$ref":"#/components/schemas/Location"},"TimeStampWithUtcOffset":{"format":"date-time","type":"string"}},"type":"object"},"DeliveryDriverAssignedDetails":{"properties":{"DriverContactNumber":{"type":"string"},"DriverName":{"type":"string"},"EstimatedArrivalTime":{"format":"date-time","type":"string"},"Location":{"$ref":"#/components/schemas/Location"},"TimeStampWithUtcOffset":{"format":"date-time","type":"string"},"VehicleDetails":{"$ref":"#/components/schemas/VehicleDetails"}},"type":"object"},"DeliveryEstimatePosition":{"properties":{"RestaurantReference":{"type":"string"},"ToLat":{"type":"string"},"ToLon":{"type":"string"},"ToPostcode":{"type":"string"}},"required":["RestaurantReference"],"type":"object"},"DeliveryLocation":{"properties":{"Latitude":{"format":"double","type":"number"},"Longitude":{"format":"double","type":"number"}},"type":"object"},"DeliveryPosition":{"properties":{"ToLat":{"format":"double","type":"number"},"ToLon":{"format":"double","type":"number"},"ToPostcode":{"type":"string"}},"type":"object"},"DeliveryableRestaurantLocationInfo":{"properties":{"Latitude":{"format":"double","type":"number"},"Longitude":{"format":"double","type":"number"},"RestaurantId":{"type":"string"},"RestaurantReference":{"type":"string"}},"type":"object"},"EstimatedDeliveryTime":{"properties":{"DurationInMinutes":{"type":"string"},"RestaurantReference":{"type":"string"}},"type":"object"},"HealthState":{"properties":{"Healthy":{"type":"boolean"},"Information":{"type":"string"}},"type":"object"},"Location":{"properties":{"Accuracy":{"format":"double","type":"number"},"Heading":{"format":"double","type":"number"},"Latitude":{"format":"double","type":"number"},"Longitude":{"format":"double","type":"number"},"Speed":{"format":"double","type":"number"}},"type":"object"},"Object":{"properties":{},"type":"object"},"OnItsWayDetails":{"properties":{"EstimatedArrivalTime":{"format":"date-time","type":"string"},"Location":{"$ref":"#/components/schemas/Location"},"TimeStampWithUtcOffset":{"format":"date-time","type":"string"}},"type":"object"},"VehicleDetails":{"properties":{"Vehicle":{"type":"string"},"VehicleRegistration":{"type":"string"}},"type":"object"}}}}