<aside> 💡 Note: If you are integrating for use on Just Eat, please use uk.api.just-eat.io/docs. Please use the link above. The content below is primarily updated for SkipTheDishes.
</aside>
When an order is received for your integrated restaurant on a delivery website, the Flyt Platform will send it to the endpoint you provided, as a POST request. Your endpoint must be able to receive orders in the format documented below.
As an additional security measure, orders can be sent from a static IP address. You can request this feature from your brand manager.
Authorization: The API key that you have provided to Flyt to send with order requests. This header will be omitted if no API key was provided.
None.
id: Flyt Platform's order ID. Used for updating the status of asynchronous orders.third_party_order_reference: delivery partner's identifier for the order. This is the order number that is displayed to the customer on the delivery partner website, and will be referenced when the order is picked up.type: indicates how the order will be fulfilled. Accepts the following values:posLocationId: the POS or 3PA identifier you have provided to Flyt for this restaurant. You should use this to route the order to the correct restaurant.location: additional details about the restaurant / location.menu_reference: the menu that the order was placed for.items: array of menu items contained in the order. Except where otherwise noted, all properties are the same as provided when the menu was last published for this restaurant.created_at: UNIX timestamp indicating when the order was created.