# Taskrabbit Developer Hub Documentation

> Easily integrate on demand delivery and home services into your application with the Taskrabbit APIs. Our universal developer hub offers a single destination for robust documentation and resources, enabling you to seamlessly build powerful new features for your users.

## Guides: HOME
- [Overview](https://developer.taskrabbit.com/docs/overview.md)
- [Getting Started](https://developer.taskrabbit.com/docs/getting-started.md): Taskrabbit's Delivery API follows a standard pattern for web APIs: REST endpoints with JSON payloads transmitted via HTTP.  Getting started is as easy as 1-2-3!

## Guides: Delivery Guides
- [Identifiers](https://developer.taskrabbit.com/docs/id-values.md): Understanding the various identifiers is helpful for a successful integration. Below is an overview on each of the values and how they should be used.
- [Webhooks](https://developer.taskrabbit.com/docs/webhooks.md): Webhooks provide an active feedback mechanism so that you can keep track of your delivery orders in near real time without making a request.
- [Quoting Deliveries](https://developer.taskrabbit.com/docs/requesting-delivery-quotes.md)
- [Scheduling Deliveries](https://developer.taskrabbit.com/docs/scheduling.md)
- [Modifying Deliveries](https://developer.taskrabbit.com/docs/modifying-deliveries.md): Sometimes the details of a delivery need to be modified.  For example, the customer would like the delivery on a different date.
- [Proof of Delivery](https://developer.taskrabbit.com/docs/proof-of-delivery.md): Dolly will provide proof of delivery (POD) for successful orders upon delivery completion.
- [Cancellations and Returns](https://developer.taskrabbit.com/docs/cancellations-and-returns.md): Partners can cancel orders that are no longer needed. In some cases, a return may be needed for orders that are canceled in progress, or for failed deliveries.
- [Postman Collection](https://developer.taskrabbit.com/docs/postman-collections.md): Dolly recommends using Postman for testing. Postman is an API platform for building, using, and testing APIs.

## Guides: Home Services Guides
- [Overview: Taskrabbit Home Services API](https://developer.taskrabbit.com/docs/overview-taskrabbit-home-services-api.md): Integrate Taskrabbit’s services directly into your online store or checkout flow. The Partner API enables you to estimate prices, show real-time availability, create bookings, and manage tasks — all…
- [Getting a Project Estimate](https://developer.taskrabbit.com/docs/project-estimate.md): Use this endpoint to check if Taskrabbit services are available in a given area and to display estimated pricing on your product or checkout pages.
- [Checking Availability](https://developer.taskrabbit.com/docs/checking-availability.md): Retrieve real-time appointment windows for a service and address combination.
- [Creating a Bid](https://developer.taskrabbit.com/docs/creating-a-bid.md): Lock in a price and reserve an appointment window before confirming a booking.
- [Booking a Project](https://developer.taskrabbit.com/docs/booking-a-project.md): Finalize a Taskrabbit project using a confirmed bid.
- [Get Service Catalog](https://developer.taskrabbit.com/docs/get-service-catalog.md): Retrieve Taskrabbit’s complete list of available services, including names, pricing, and requirements.
- [Get Project Status](https://developer.taskrabbit.com/docs/get-project-status.md): Retrieve the current status of a Taskrabbit booking
- [Canceling a Project](https://developer.taskrabbit.com/docs/canceling-a-project.md): Cancel a Taskrabbit booking and trigger standard workflows (Tasker notification, refund, and policy rules).
- [Webhooks](https://developer.taskrabbit.com/docs/webhooks-1.md): Webhooks provide a real-time notification mechanism so that you can keep track of your projects without polling our API.

## API Reference: Taskrabbit Delivery
- Deliveries
  - [Create Delivery](https://developer.taskrabbit.com/reference/create-delivery.md): Once authenticated, partners can book a Dolly delivery by providing the appropriate partner and client IDs, as well as the what, when, and where of a delivery request.
  - [Get Delivery Info](https://developer.taskrabbit.com/reference/get-delivery-info.md): To retrieve a complete account of details and status on any previously created delivery, make a Get Delivery Info request. Responses Include assigned Helper names, any pertinent status, and all other…
  - [Cancel Delivery](https://developer.taskrabbit.com/reference/cancel-delivery.md): To update a quote into a delivery request, by providing all required information including the what, when, and where of an order.
  - [Add / Update Delivery Units](https://developer.taskrabbit.com/reference/add-update-delivery-units.md): A Delivery Unit is the virtual representation of a single, physical container (such as a box or bag) used to consolidate multiple items within a delivery.  Instead of tracking loose items, this…
  - [Add Delivery Tip](https://developer.taskrabbit.com/reference/updating-tips.md): Update the tip for a specific delivery using its unique identifier.
  - [Create Quote](https://developer.taskrabbit.com/reference/create-quote.md): To generate a quote which returns the current price for an order based on the order details provided. The price quoted is only relevant at the time it is requested.
  - [Book Quoted Delivery](https://developer.taskrabbit.com/reference/book-quoted-delivery.md): To update a quote into a delivery request, by providing all required information including the what, when, and where of an order.
  - [Get Quote Info](https://developer.taskrabbit.com/reference/get-quote-info.md): To retrieve a complete account of details and status on any previously created quote, make a Get Quote by ID request. Responses Include quoted price, any pertinent status, and all other details…
- Routes
  - [Create Route](https://developer.taskrabbit.com/reference/create-route.md): A route is a group of deliveries which will be fulfilled together. Partners can book a Dolly route after creating Dolly deliveries. This endpoint creates a Dolly route, allowing a partner to group…
- Fail
  - [Return Error](https://developer.taskrabbit.com/reference/a-simple-route-that-verifies-error-handling-works-1.md): A simple route that verifies error handling works by returning an an error response
- Me
  - [Get Partner Info](https://developer.taskrabbit.com/reference/get-partner-information.md): Get an authorized partner's information
- Ping
  - [Return Ping](https://developer.taskrabbit.com/reference/a-simple-route-that-can-be-used-to-validate-that-the-api-is-up-and-running.md): A simple route that can be used to validate that the API is up and running.

## API Reference: Taskrabbit Partner Platform API
- Project Booking APIs
  - [Estimate Services](https://developer.taskrabbit.com/reference/projectestimate.md): This endpoint is responsible for returning an estimated price for a service on a specific product for a postal code and country, or full address. Both postal code and country are required for…
  - [Check Service Availability](https://developer.taskrabbit.com/reference/projectavailability.md): During the booking process, customers need to choose their desired date/time window for their project. The Availability endpoint will return the available time windows for booking the services, along…
  - [Bid Project Agreement](https://developer.taskrabbit.com/reference/projectbid.md): Once the customer chooses their desired date/time window for their project, the Bid endpoint will create an agreement for that specific date/time window and return the most accurate pricing. It will…
  - [Book a Project Agreement](https://developer.taskrabbit.com/reference/projectbook.md): This endpoint completes the booking of a project on Taskrabbit with the Project ID, customer information, Taskrabbit’s Terms of Service & Privacy Policy Acceptance Indicator (Y/N), Description to be…
  - [Create Appointment Request](https://developer.taskrabbit.com/reference/createappointment.md): Creates an appointment request for a given Project. This sets the target start time and triggers downstream scheduling actions. The target start time must be within the agreement's valid scheduling…
- Collection Retrieval APIs
  - [List Projects](https://developer.taskrabbit.com/reference/listprojects.md): Retrieves a flat list of Projects. Supports optional sorting and filtering by project status and service provider brand UUIDs.
  - [Retrieve a Project by UUID](https://developer.taskrabbit.com/reference/getprojectbyuuid.md): Retrieves detailed information about a specific project using its UUID.
  - [Lists Services belonging to a specific Brand.](https://developer.taskrabbit.com/reference/listservicesbybranduuid.md): This endpoint uses a Brand UUID to retrieve all the services associated to that Brand. It returns the list of services and also, if `include_pricing` param is present and has a `true` value, appends…
- Entity Mutation APIs
  - [Update external identifier of a Service](https://developer.taskrabbit.com/reference/updateserviceexternalidentifier.md): Updates the external_identifier of a given Service using its UUID.
  - [Cancels a booked Project](https://developer.taskrabbit.com/reference/cancelbookedproject.md): Cancels a booked Project on Taskrabbit with the Project ID and the Cancellation Reason
  - [Check Reschedule Availability](https://developer.taskrabbit.com/reference/getrescheduleavailability.md): Check available time windows for rescheduling an existing project to a new date/time.
  - [Reschedule Project](https://developer.taskrabbit.com/reference/rescheduleproject.md): Reschedule an existing project to a new target start time.

## API Reference: Partner Public API — ep-v2
- ep-v2
  - [Create an Order](https://developer.taskrabbit.com/reference/epv2orderscontroller_createorder.md)
  - [Get Order Info](https://developer.taskrabbit.com/reference/epv2orderscontroller_getorder.md)
  - [Update Order](https://developer.taskrabbit.com/reference/epv2orderscontroller_updateorder.md)
  - [Cancel an Order](https://developer.taskrabbit.com/reference/epv2orderscontroller_cancelorder.md)
  - [Create a Quote](https://developer.taskrabbit.com/reference/epv2quotescontroller_createquote.md)
  - [Get Quote Info](https://developer.taskrabbit.com/reference/epv2quotescontroller_getquote.md)
  - [Update Quote](https://developer.taskrabbit.com/reference/epv2quotescontroller_updatequote.md)
  - [Book a Quoted Order](https://developer.taskrabbit.com/reference/epv2quotescontroller_bookquote.md)