Overview

The Delivery Only API allows any order to source a connected delivery provider in order to provide end users with the most seamless delivery experience possible.

This could be from your 1P channel with an existing Direct Integration to your POS or sourcing a delivery for a phone in order being punched straight in to your POS.

The Delivery Only API provides our partners with all Deliverect Dispatch has to offer without causing any duplicated entries to your POS or just gets you a great delivery experience from your source of truth.

Base URLs
These are the base URLs for Store endpoints hosted on the Deliverect domain.

Environment	Base URL	Description
Staging	https://api.staging.deliverect.com	For any integration partner accessing endpoints in our Staging (test) Environment
Production	https://api.deliverect.com	For any integration partner accessing endpoints in our Production (live) Environment

ENDPOINT	TYPE	FUNCTION
STANDALONE DISPATCH AVAILABILITY 🔗	POST	Check on the availability of Dispatch services before creating an order
CREATE / CANCEL ORDER	POST	Creating an order for Delivery to be assigned to Dispatch service or cancelling the order.
COURIER STATUS UPDATE WEBHOOK 🔗	POST	Receive status updates on the progress of order delivery

%%{init: { "theme": "base", "themeVariables": { "fontSize": "18px", "background": "transparent", "actorBkg": "#038851", "actorTextColor": "#ffffff", "actorBorder": "#026139", "actorLineColor": "#94a3b8", "signalColor": "#64748b", "signalTextColor": "#059669", "noteBkgColor": "#e6f4ee", "noteTextColor": "#02502f", "noteBorderColor": "#038851", "activationBkgColor": "#c6ebdc", "activationBorderColor": "#026139", "sequenceNumberColor": "#ffffff" }, "sequence": { "useMaxWidth": true, "actorMargin": 70, "width": 150, "height": 60, "boxMargin": 12, "noteMargin": 14, "messageMargin": 50, "diagramMarginX": 20, "diagramMarginY": 20, "actorFontSize": 18, "actorFontWeight": 700, "noteFontSize": 15, "noteFontFamily": "ui-monospace, SFMono-Regular, Menlo, Consolas, monospace", "messageFontSize": 16, "messageFontWeight": 700, "noteAlign": "left", "mirrorActors": false } }}%%
sequenceDiagram
    autonumber
    participant P as Partner<br/>(1P channel / POS)
    participant D as Deliverect API<br/>(staging / production)
    participant C as Dispatch Provider<br/>(courier)

    Note over P,D: Base URL<br/>Staging: https://api.staging.deliverect.com<br/>Production: https://api.deliverect.com

    P->>D: Get Access Token
    D-->>P: Bearer token

    rect rgba(3, 136, 81, 0.08)
    Note over P,D: 1. Dispatch Availability
    P->>D: POST Dispatch Availability
    D->>C: Check courier availability
    C-->>D: Availability / quote
    D-->>P: Dispatch available?
    end

    alt Dispatch available
        rect rgba(3, 136, 81, 0.08)
        Note over P,D: 2. Create Order
        P->>D: POST Create Order (delivery)
        D->>C: Assign order to dispatch service
        C-->>D: Assignment confirmed
        D-->>P: Order created
        end

        rect rgba(3, 136, 81, 0.08)
        Note over P,C: 3. Courier Status Update Webhook
        loop Delivery progress
            C->>D: Courier status change
            D->>P: POST Courier Status Update (webhook)
            P-->>D: 200 OK
        end
        end

        opt Order needs cancelling
            Note over P,D: 4. Cancel Order
            P->>D: POST Cancel Order
            D->>C: Cancel delivery
            D-->>P: Cancellation confirmed
        end
    else Dispatch not available
        D-->>P: No courier available — fall back to own delivery
    end