### Menu API - Webhooks & Management Source: https://api.developers.deliveroo.com/reference/create-prep-stage-1 Manages menu event webhooks, allowing integrators to subscribe to menu changes. Includes endpoints for getting and changing webhook configurations. ```APIDOC Menu API - Webhooks & Management: - Menu Webhook Callback: POST /reference/menu-events-webhook - Get Integrator's Menu Events Webhook: GET /reference/get-menu-events-webhook - Change Integrator's Menu Events Webhook: PUT /reference/put-menu-events-webhook ``` -------------------------------- ### Picking API Endpoints V1 Source: https://api.developers.deliveroo.com/reference/create-prep-stage-1 Provides endpoints for managing the picking process for orders, including starting, accepting, rejecting, and amending orders. It also allows fetching order substitutions and active orders. ```APIDOC Endpoints V1: PUT /reference/picking-v1-start-picking Description: Initiates the picking process for a specific order. PUT /reference/picking-v1-accept-order Description: Accepts an order for picking. PUT /reference/picking-v1-reject-order Description: Rejects an order from the picking process. POST /reference/picking-v1-amend-order Description: Allows partners to make amendments to order items during picking. GET /reference/picking-v1-get-order-substitutions Description: Retrieves information about allowed item substitutions for an order. GET /reference/picking-v1-get-active-orders Description: Fetches a list of currently active orders that require picking. ``` -------------------------------- ### Site API Endpoints Source: https://api.developers.deliveroo.com/reference/create-prep-stage-1 Enables management and retrieval of site-specific information, including status, days off, opening hours, time zones, listings, and workload modes. It covers operations for getting and updating these details. ```APIDOC Introduction: /reference/introduction-2 Description: General introduction to the Site API. Status: GET /reference/get-site-status Description: Retrieves the current status of a site. PUT /reference/update-site-status Description: Updates the status of a site. Days Off: GET /reference/get-days-off-by-id Description: Retrieves a site's days off period by ID. PUT /reference/update-days-off Description: Updates a site's days off period. DELETE /reference/cancel-days-off Description: Cancels a site's days off period. POST /reference/add-new-days-off Description: Adds a new days off period for a site. GET /reference/get-all-days-off-for-a-site Description: Retrieves all days off for a specific site. Opening Hours: GET /reference/get-site-opening-hours Description: Retrieves the opening hours for a site. POST /reference/update-site-opening-hours Description: Updates the opening hours for a site. Time Zone: GET /reference/get-site-time-zone Description: Retrieves the time zone configured for a site. Listing: GET /reference/get-sites-for-a-brand Description: Retrieves a list of sites associated with a specific brand. Workload Mode: GET /reference/get-site-workload-mode Description: Retrieves the current workload mode for a site. PUT /reference/set-site-workload-mode Description: Sets or updates the workload mode for a site. Workload Times: GET /reference/get-site-workload-times Description: Retrieves the workload times for a site. PUT /reference/set-site-workload-times Description: Sets or updates the workload times for a site. Brand ID: GET /reference/get_v2-site-brand-id Description: Retrieves the brand ID for a given site. Brands: GET /reference/get-all-brands Description: Retrieves a list of all available brands. ``` -------------------------------- ### Menu API - v1 (Recommended) Source: https://api.developers.deliveroo.com/reference/create-prep-stage-1 Manages menus using API version 1, recommended for most use cases. Supports fetching, uploading, and updating menu items, including PLU mappings and item availabilities. ```APIDOC Menu API - v1 (Recommended): - Get menu: GET /reference/get_v1-brands-brand-id-menus-id - Upload menu: PUT /reference/put_v1-brands-brand-id-menus-id - Update PLU to Menu Item mapping: POST /reference/post_v1-brands-brand-id-menus-id-plus - Replace All Menu Item Unavailabilities: PUT /reference/put_v1-brands-brand-id-menus-id-item-unavailabilities-site-id - Update Individual Menu Item unavailabilities: POST /reference/post_v1-brands-brand-id-menus-id-item-unavailabilities-site-id - Get Menu Item unavailabilities: GET /reference/get_v1-brands-brand-id-menus-id-item-unavailabilities-site-id ``` -------------------------------- ### Orders API - Endpoints V1 Source: https://api.developers.deliveroo.com/reference/create-prep-stage-1 Provides core functionalities for managing orders via API version 1. Includes creating sync statuses, preparation stages, updating order status, retrieving order details, and managing webhook configurations. ```APIDOC Orders API - Endpoints V1: - Create Sync Status for an Order: POST /reference/create-sync-status-1 - Create Preparation Stage for an Order: POST /reference/create-prep-stage-1 - Update Order Status: PATCH /reference/patch-order-1 - Get Single Order Details: GET /reference/get-order-1 - Get Orders: GET /reference/get-orders - Get Integrator's Order Events Webhook Configuration: GET /reference/get-order-events-webhook-config - Change Integrator's Order Events Webhook Configuration: PUT /reference/put-order-events-webhook-config - Get Integrator's Rider Events Webhook configuration: GET /reference/get-rider-events-webhook-1 - Change Integrator's Rider Events Webhook configuration: PUT /reference/put-rider-events-webhook-1 - Get Integrator's Sites Webhooks Configuration: GET /reference/get-sites-config - Change Integrator's Sites Webhooks Configuration: PUT /reference/put-sites-config ``` -------------------------------- ### Menu API - v2 (Menu Manager) Source: https://api.developers.deliveroo.com/reference/create-prep-stage-1 Handles menus created via the Menu Manager using API version 2. Supports fetching menus and managing item availabilities at the site level. ```APIDOC Menu API - v2 (Menu Manager): - Get menu: GET /reference/get_v2-brands-brand-id-sites-site-id-menu - Replace All Menu Item Unavailabilities: PUT /reference/put_v2-brands-brand-id-sites-site-id-menu-item-unavailabilities - Update individual Menu Item unavailabilities: POST /reference/post_v2-brands-brand-id-sites-site-id-menu-item-unavailabilities - Get Menu Item unavailabilities: GET /reference/get_v2-brands-brand-id-sites-site-id-menu-item-unavailabilities ``` -------------------------------- ### Deliveroo Signature API - v2 Endpoints Source: https://api.developers.deliveroo.com/reference/create-prep-stage-1 Key v2 API endpoints for order creation and location retrieval. ```APIDOC Signature API v2: - Create a new order (POST): /reference/create-order-v2 - Get order location (GET): /reference/get-order-location-v2 Description: These are the version 2 endpoints for order management, offering updated functionality for creating new orders and retrieving their current location. Partners should use these for the latest features. Authentication is required, typically using OAuth2. ``` -------------------------------- ### Picking API Webhook Configuration Source: https://api.developers.deliveroo.com/reference/create-prep-stage-1 Manages webhook configurations for the Picking API, allowing partners to receive real-time updates on picking events. Includes endpoints for retrieving and configuring webhooks for brands and integrators. ```APIDOC Webhook URL Configuration: GET /reference/picking-v1-get-brand-webhook-configuration Description: Retrieves the Picking API webhook configuration for a specific brand. PUT /reference/put-brand-webhook-configuration Description: Configures or updates the Picking API webhook for a brand. GET /reference/picking-v1-get-webhook-configuration Description: Retrieves the Picking API webhook configuration for an integrator. PUT /reference/put-webhook-configuration Description: Configures or updates the Picking API webhook for an integrator. POST /reference/webhook-receiver-example Description: Provides an example endpoint for receiving Picking API webhooks. ``` -------------------------------- ### Deliveroo Signature API - v1 Endpoints Source: https://api.developers.deliveroo.com/reference/create-prep-stage-1 Core v1 API endpoints for managing orders, quotes, restaurants, and webhooks. ```APIDOC Signature API v1: - Create a new order (POST): /reference/create-order-v1 - Get information about an order (GET): /reference/get-order-v1 - Get order location (GET): /reference/get-order-location-v1 - Create quote (POST): /reference/create-quote - Get restaurants for location (GET): /reference/get-restaurants - List registered webhooks (GET): /reference/get-webhooks - Register webhooks (POST): /reference/configure-webhooks - Submit a refund notification for an order (POST): /reference/create-refund-notification Description: This set of endpoints allows partners to programmatically create and manage orders, retrieve order details and locations, generate quotes, find available restaurants, and configure webhook subscriptions for status updates. Authentication is required, typically using OAuth2. ``` -------------------------------- ### Developer Portal API - Scenarios Source: https://api.developers.deliveroo.com/reference/create-prep-stage-1 Enables interaction with developer scenarios, including retrieving scenario details, triggering runs, and fetching run history. This API is used for testing and managing development workflows. ```APIDOC Scenarios: GET /reference/get_scenarios-1 Description: Retrieves a list of all available scenarios. GET /reference/get_scenarios-id-1 Description: Retrieves a specific scenario by its unique ID. POST /reference/post_scenarios-id-runs-1 Description: Triggers a new run for a scenario identified by its ID. GET /reference/get_scenarios-id-runs-1 Description: Retrieves the history of runs for a specific scenario. GET /reference/get_scenarios-id-runs-run-id-1 Description: Retrieves details of a specific scenario run by its ID. ``` -------------------------------- ### Menu API - v3 (Large Uploads) Source: https://api.developers.deliveroo.com/reference/create-prep-stage-1 Facilitates large menu uploads using API version 3. Includes creating S3 URLs for uploads, publishing menus, fetching menu data, and checking job statuses. ```APIDOC Menu API - v3 (Large Uploads): - Create S3 URL for uploading menu: PUT /reference/put_v3-brands-brand-id-menus-id - Publish Menu: POST /reference/post_v3-brands-brand-id-jobs - Fetch Menu: GET /reference/get_v3-brands-brand-id-menus-id - Get Job status: GET /reference/get_v3-brands-brand-id-jobs-job-id ``` -------------------------------- ### Authentication API Source: https://api.developers.deliveroo.com/reference/create-prep-stage-1 Provides endpoints for authentication, including credential exchange and obtaining access tokens. This section covers the necessary steps to authenticate with the Deliveroo API. ```APIDOC Authentication: - Exchange credentials: /reference/credentials - Credential Types: /reference/credentials - Get access token: POST /reference/get-access-token ``` -------------------------------- ### Create Preparation Stage for an Order Source: https://api.developers.deliveroo.com/reference/create-prep-stage-1 Endpoint to update Deliveroo on the preparation progress of an order, intended for kitchen management systems. ```APIDOC POST https://api.developers.deliveroo.com/order/v1/orders/{order_id}/prep_stage Description: Use this endpoint to inform Deliveroo about the current preparation stage of an order. This is particularly useful for partners integrating with kitchen management systems to provide real-time updates. Parameters: - order_id (path parameter): The unique identifier for the order. Credentials: - OAuth2 - Bearer Token Example Usage (Conceptual): curl -X POST \ https://api.developers.deliveroo.com/order/v1/orders/YOUR_ORDER_ID/prep_stage \ -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ -H 'Content-Type: application/json' -d '{"stage": "cooking_complete"}' Note: The exact request body format for 'stage' would be detailed in the full API specification. ``` -------------------------------- ### Catalogue API Endpoints Source: https://api.developers.deliveroo.com/reference/create-prep-stage-1 Provides endpoints for managing product catalogues, including uploading, updating prices, and managing listings and unavailabilities. It also includes webhook configurations for catalogue-related events. ```APIDOC Catalogue Upload: POST /reference/catalogueupload Description: Initiates a catalogue upload process. Upload URL (from catalogue upload response): PUT /reference/uploadurl Description: Provides a URL to upload catalogue data, typically received as a response to a catalogue upload initiation. Get Catalogue: GET /reference/getcatalogue Description: Retrieves the current catalogue information. Update Prices (Upcoming): PUT /reference/updateprices Description: Endpoint for updating product prices. Specific details for per-site updates are also mentioned. Update Listings: PUT /reference/updatelistings Description: Allows for updating product listings within the catalogue. Update Unavailabilities: PATCH /reference/updateunavailabilities Description: Updates the unavailability status of items or listings. Get Unavailabilities: GET /reference/getunavailabilities Description: Retrieves the current unavailability information for catalogue items. Webhooks: POST /reference/uploadcataloguewebhook Description: Configures a webhook for catalogue upload events. POST /reference/updatecataloguelistingswebhook Description: Configures a webhook for updates to catalogue listings. POST /reference/updatecataloguepriceswebhook Description: Configures a webhook for updates to catalogue prices. ``` -------------------------------- ### Picking API Endpoints V2 Source: https://api.developers.deliveroo.com/reference/create-prep-stage-1 Provides an updated set of endpoints for managing the picking process, specifically focusing on updating order item quantities. ```APIDOC Endpoints V2: PUT /reference/picking-v2-update-order Description: Updates the quantity of items within an order during the picking process. ``` -------------------------------- ### Orders API - Webhooks Source: https://api.developers.deliveroo.com/reference/create-prep-stage-1 Handles webhook callbacks for order and rider events. This allows integrators to receive real-time updates from Deliveroo regarding order status changes and rider activities. ```APIDOC Orders API - Webhooks: - Order Events Webhook Callback: POST /reference/order-events-webhook-1 - Rider Events Webhook Callback: POST /reference/rider-events-webhook-1 - POS Webhook - New Order: POST /reference/new-order-event-webhook-1 - POS Webhook - Cancel Order: POST /reference/cancel-order-event-webhook-1 ``` -------------------------------- ### Orders API - Endpoints V2 Source: https://api.developers.deliveroo.com/reference/create-prep-stage-1 Offers updated endpoints for retrieving order information via API version 2. This includes fetching single order details and lists of orders. ```APIDOC Orders API - Endpoints V2: - Get Single Order Details: GET /reference/get-order-v2 - Get Orders: GET /reference/get-orders-v2 ``` -------------------------------- ### Deliveroo Express API - v1 Endpoints Source: https://api.developers.deliveroo.com/reference/create-prep-stage-1 v1 API endpoints for managing express deliveries, including quotes, scheduling, and status retrieval. ```APIDOC Deliveroo Express API v1: - Create quote (POST): /reference/createquotev1 - Get quote (GET): /reference/getquotev1 - Update quote (PATCH): /reference/updatequotev1 - Get deliveries by latitude and longitude (GET): /reference/getdeliveriesbylatlon - Schedule delivery (POST): /reference/scheduledeliveryv1 - Get delivery (GET): /reference/getdeliveryv1 - Cancel delivery (DELETE): /reference/canceldeliveryv1 - Get Availability (GET): /reference/getavailabilityv1 Description: This section covers the v1 API for Deliveroo Express, enabling partners to manage express delivery services. Functionality includes creating, retrieving, and updating quotes, fetching deliveries based on location, scheduling new deliveries, checking delivery status, canceling deliveries, and querying availability. OAuth2 authentication is required. ``` -------------------------------- ### Deliveroo Signature API - Webhook Callbacks Source: https://api.developers.deliveroo.com/reference/create-prep-stage-1 Endpoints for receiving asynchronous notifications from Deliveroo regarding order status, refunds, credits, redeliveries, and rider status changes. ```APIDOC Webhook Callbacks: - Order Status Callback (POST): /reference/signature-order-status - Order Refund Callback (POST): /reference/signature-order-refund - Order Credit Callback (POST): /reference/signature-order-credit - Order Redelivery Callback (POST): /reference/signature-order-redelivery - Rider Status Callback (POST): /reference/signature-rider-status Description: These endpoints are designed to receive callback notifications from Deliveroo. Your system should expose these URLs to receive real-time updates on various events related to orders and deliveries. Authentication is typically handled via OAuth2 or Bearer tokens. ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.