openapi: 3.0.3
info:
  title: TaskRabbit Partner Delivery API
  description: 'TaskRabbit''s Partner API program, documented at developer.taskrabbit.com, spans two live surfaces: the Home Services Partner Platform (versioned 2025-12) covering the Estimate, Availability, Bid, Book project workflow plus catalog and cancellation/reschedule management, and the Delivery API inherited from Dolly (acquired by TaskRabbit in November 2024 and rebranded TaskRabbit Delivery). Both surfaces require partner approval and Auth0 OAuth2 client-credentials (machine-to-machine) tokens; there is no public self-serve signup. Endpoint shapes below are modeled from TaskRabbit''s public developer documentation (method, path, and the parameters/fields the docs describe); exact request/response schemas are partially withheld behind the gated Postman collection and reference pages given to approved partners, so object schemas here are best-effort and marked accordingly rather than fabricated in full detail.'
  version: 2025-12
  contact:
    name: TaskRabbit Developer Hub
    url: https://developer.taskrabbit.com
  x-endpointsModeled: true
  x-accessModel: Partner-approval gated; no public self-serve signup.
servers:
- url: https://{api_subdomain}.partner-platform.taskrabbit.com/2025-12
  description: TaskRabbit Home Services Partner Platform (partner-specific subdomain, Sandbox and Production)
  variables:
    api_subdomain:
      default: your-subdomain
      description: Subdomain issued to the partner during onboarding.
- url: https://papi.dolly.com/v1
  description: TaskRabbit Delivery (Dolly) Partner API - Production
- url: https://papi.sandbox.dolly.com/v1
  description: TaskRabbit Delivery (Dolly) Partner API - Sandbox
security:
- oauth2: []
tags:
- name: Delivery
  description: Dolly-based on-demand delivery, quoting, and routing.
paths:
  /deliveries:
    post:
      operationId: createDelivery
      tags:
      - Delivery
      summary: Create Delivery
      description: Quotes and creates an on-demand delivery via TaskRabbit Delivery (Dolly). Server variable for this path is the Dolly PAPI base URL, not the Home Services partner-platform host.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: Pickup/dropoff addresses, item/unit details, and vehicle/service level; full field list is provided via the partner Postman collection.
      responses:
        '200':
          description: Delivery created.
  /me:
    get:
      operationId: getPartnerInformation
      tags:
      - Delivery
      summary: Get Partner Info
      description: Returns the authorized partner's information (icon URL, store display name, partner ID, subject ID).
      responses:
        '200':
          description: Partner information.
          content:
            application/json:
              schema:
                type: object
                properties:
                  defaultIconUrl:
                    type: string
                  defaultStoreDisplayName:
                    type: string
                  partnerId:
                    type: string
                  subjectId:
                    type: string
              example:
                defaultIconUrl: https://dolly.com/images/dolly-logo-pink.svg
                defaultStoreDisplayName: Dolly QA
                partnerId: dolly
                subjectId: k0DjAYBzosSIbUU2AMdMLKtpk0tv081Z
  /ping:
    get:
      operationId: pingDeliveryApi
      tags:
      - Delivery
      summary: Return Ping
      description: A simple route that can be used to validate that the Delivery API is up and running.
      responses:
        '200':
          description: Service is healthy.
components:
  securitySchemes:
    oauth2:
      type: oauth2
      description: Auth0 machine-to-machine (M2M) OAuth2 client-credentials grant. Credentials are issued during partner onboarding.
      flows:
        clientCredentials:
          tokenUrl: https://taskrabbit.auth0.com/oauth/token
          scopes: {}