> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tybritelabs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quote on-demand delivery tiers

> Return on-demand (ride-hail / independent-driver) fare quotes for the order's
corridor across the available tiers — `express` (dedicate a trip now, same-city
only), `on_the_way` (a driver already heading there carries it; cheapest), and
`scheduled` (flexible window). Tiers are eligible only when the merchant has enabled
on-demand and the corridor allows it. Pricing is flat per corridor, not per-km.




## OpenAPI

````yaml /tldp/openapi.yaml get /v1/orders/{orderId}/on-demand-quote
openapi: 3.1.0
info:
  title: TLDP API
  version: 1.0.0
  description: >
    # Tybrite Logistics Developer Platform (TLDP) API


    The unified logistics API — one integration aggregates many courier

    services (rates, shipment creation, real-time tracking, proof of delivery,

    webhooks). "Stripe for logistics."


    ## Authentication

    All requests use API-key bearer auth. Keys are dual-key:

    - **Secret** (`tybrite_sk_live_*` / `tybrite_sk_test_*`) — full read/write.

    - **Publishable** (`tybrite_pk_live_*` / `tybrite_pk_test_*`) — read-only.


    ```

    Authorization: Bearer tybrite_sk_live_...

    ```


    `_live_` keys hit production; `_test_` keys hit the sandbox.


    ## Rate limits

    Authenticated endpoints are limited **per API key** (the `/v1` API is
    server-to-server —

    your backend holds the key — so the key is the identity). Fixed 60-second
    window:

    - **Production: 120 requests / minute / key**

    - **Sandbox: 30 requests / minute / key** (throttled harder for testing)


    The public tracking endpoint (no key) is limited **per IP** (60 / minute /
    IP).


    Every response carries `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and

    `X-RateLimit-Reset` (unix epoch seconds). Exceeding the window returns

    **429** `rate_limit_exceeded`.


    ## Status code conventions

    - **201 Created** — a POST that creates a new resource (`POST /v1/orders`,
      `/v1/shipments`, `…/fulfil`, `…/fulfil-on-demand`, `POST /v1/webhooks`).
    - **200 OK** — reads, and POSTs that mutate without creating (`…/cancel`),
    or an
      **idempotent replay** (e.g. `POST /v1/shipments` with a reused `Idempotency-Key`
      returns the original shipment as 200, not a duplicate).
    - **202 Accepted** — work queued asynchronously (`POST
    /v1/webhooks/{id}/test`).


    ## Idempotency

    Write endpoints accept an `Idempotency-Key` header; retrying with the same
    key

    returns the original result instead of creating a duplicate.


    ## Caching

    Read endpoints whose body is the same for everyone — **public tracking**
    (~15s) and

    **coverage zones** (~5min) — are edge-cached and ETag-validated. Each
    returns `ETag`,

    `Cache-Control`, and `X-Cache` (`HIT`/`MISS`). Send the `ETag` back as
    `If-None-Match` to

    get a **304 Not Modified** (empty body) when the resource is unchanged —
    cheaper for you and

    for us. Per-tenant/authed data is never edge-cached.


    ## Webhook events — two layers, decoupled on purpose

    Subscribe at `POST /v1/webhooks`. Events live at **two distinct layers**
    that answer

    different questions — subscribe to whichever you need:


    - **`order.*` = business / commitment state** (one event per transition). An
    order is the
      thing your buyer placed; these tell you where it is in *your* fulfilment workflow.
      - `order.created` — an order was pushed/placed.
      - `order.fulfilled` — the merchant committed the order to delivery and **a shipment now
        exists for it**. Fires **once**. Use this to mark your order "shipping" and stop allowing
        buyer edits.
      - `order.cancelled` — the order was cancelled (and any not-yet-picked-up shipment with it).
      - *(returns)* `return.requested`, `return.approved`, `return.rejected`, `return.received`,
        `return.refunded`, `return.exchanged` — the reverse-logistics lifecycle.

    - **`shipment.*` = physical-delivery telemetry** (many events as the parcel
    moves). This is
      the play-by-play emitted as the rider advances status: `shipment.created`,
      `shipment.payment_confirmed`, `shipment.assigned`, `shipment.picked_up`,
      `shipment.in_transit`, `shipment.out_for_delivery`, `shipment.delivered`,
      `shipment.failed`, `shipment.cancelled`. Subscribe for live tracking / proof of delivery.

    - **`payment.*`**: `payment.pending_settlement`, `payment.settled`.


    **Relationship:** an order has exactly **one** `order.fulfilled`, but
    **many** `shipment.*`

    updates underneath it. They are deliberately decoupled: if you only track
    order state,

    subscribe to `order.*`; if you want live movement, subscribe to
    `shipment.*`. Note that

    **order-less direct shipments** (created via `POST /v1/shipments` with no
    order) emit

    `shipment.*` only — never `order.*`. Conversely an order that hasn't been
    fulfilled yet has

    `order.*` but no `shipment.*`.


    Every delivery is HMAC-signed (`TLDP-Signature: t=…,v1=…`, HMAC-SHA256 of
    `${t}.${body}`

    with your endpoint's `signing_secret`). Respond `2xx` to acknowledge.


    ## Errors

    Errors return `{ "error": { "code", "message", "details?" } }` with a
    conventional

    HTTP status. Common codes: `invalid_request` (400), `unauthorized` /

    `invalid_api_key` (401), `forbidden` / `account_inactive` (403), `not_found`
    (404),

    `cannot_fulfil` / `cannot_cancel` / `cannot_edit` (409),
    `rate_limit_exceeded` (429),

    `server_error` (500).
  contact:
    name: TLDP Developer Support
    email: developers@tybritelabs.com
  license:
    name: Proprietary
    url: https://tybritelabs.com/terms
servers:
  - url: https://api.tybritelabs.com/logistics
    description: Production (use _live_ keys) and Sandbox (use _test_ keys)
security:
  - BearerAuth: []
tags:
  - name: Rates
    description: Calculate shipping rates across couriers and list coverage zones.
  - name: Orders
    description: Push customer orders from your store and fulfil them with shipments.
  - name: Returns
    description: >-
      Returns & exchanges — request, approve, receive, and resolve
      (refund/exchange).
  - name: Shipments
    description: Create, retrieve, and cancel shipments.
  - name: Tracking
    description: Public and authenticated shipment tracking.
  - name: Proof of Delivery
    description: Retrieve proof of delivery for delivered shipments.
  - name: Webhooks
    description: Manage webhook endpoints and test deliveries.
  - name: System
    description: Health and service metadata.
externalDocs:
  description: TLDP Documentation
  url: https://docs.tybritelabs.com/tldp
paths:
  /v1/orders/{orderId}/on-demand-quote:
    get:
      tags:
        - Orders
      summary: Quote on-demand delivery tiers
      description: >
        Return on-demand (ride-hail / independent-driver) fare quotes for the
        order's

        corridor across the available tiers — `express` (dedicate a trip now,
        same-city

        only), `on_the_way` (a driver already heading there carries it;
        cheapest), and

        `scheduled` (flexible window). Tiers are eligible only when the merchant
        has enabled

        on-demand and the corridor allows it. Pricing is flat per corridor, not
        per-km.
      operationId: onDemandQuote
      parameters:
        - name: orderId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Tier quotes.
          content:
            application/json:
              schema:
                type: object
                properties:
                  tiers:
                    type: array
                    items:
                      type: object
                      properties:
                        tier:
                          $ref: '#/components/schemas/OnDemandTier'
                        eligible:
                          type: boolean
                        reason:
                          type:
                            - string
                            - 'null'
                        fare:
                          type:
                            - number
                            - 'null'
                        eta_min:
                          type:
                            - integer
                            - 'null'
              example:
                tiers:
                  - tier: express
                    eligible: true
                    reason: null
                    fare: 150
                    eta_min: 15
                  - tier: on_the_way
                    eligible: true
                    reason: null
                    fare: 60
                    eta_min: 15
                  - tier: scheduled
                    eligible: true
                    reason: null
                    fare: 80
                    eta_min: 15
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  schemas:
    OnDemandTier:
      type: string
      enum:
        - express
        - on_the_way
        - scheduled
        - driver_rate_card
      description: >
        On-demand delivery speed. `express` = dedicate a trip now (same-city
        only, priciest);

        `on_the_way` = a driver already heading there carries it (cheapest);
        `scheduled` =

        flexible window (parcel rides along a trip); `driver_rate_card` = a
        driver's own price.

        Pricing is flat per corridor, not per-km.
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: invalid_request
            message:
              type: string
            details:
              type: object
              additionalProperties: true
            request_id:
              type: string
          required:
            - code
            - message
      required:
        - error
  responses:
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            unauthorized:
              summary: No Authorization header
              value:
                error:
                  code: unauthorized
                  message: Missing or invalid Authorization header
            invalid_api_key:
              summary: Key revoked or wrong environment
              value:
                error:
                  code: invalid_api_key
                  message: API key is invalid or revoked
    NotFound:
      description: The requested resource does not exist (or isn't yours).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: not_found
              message: Order not found
    RateLimited:
      description: Rate limit exceeded for the current window.
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: rate_limit_exceeded
              message: Too many requests. Retry after the window resets.
    ServerError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: server_error
              message: An unexpected error occurred. Try again or contact support.
  headers:
    X-RateLimit-Limit:
      description: Requests allowed in the current window.
      schema:
        type: integer
    X-RateLimit-Remaining:
      description: Requests remaining in the current window.
      schema:
        type: integer
    X-RateLimit-Reset:
      description: Unix epoch (seconds) when the window resets.
      schema:
        type: integer
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: tybrite_sk_live_* or tybrite_pk_live_*
      description: >
        API key as a bearer token. Secret keys (sk_) allow writes; publishable
        keys (pk_) are read-only. live = production, test = sandbox.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.