Wash & Detail

Overview

Drivly’s Wash & Detail API simplifies the complex process of managing vehicle wash and detail services, offering a straightforward solution for obtaining quotes and placing orders.

With a simple API, businesses can easily access a network of professional service providers, ensuring vehicles receive the best care promptly.

Workflows

The Wash & Detail API facilitates two primary functions, Quote and Order a car wash and detailing service for a vehicle, including interior and exterior cleaning, waxing, polishing, and paint correction.

Quote Wash & Detail

You can obtain a quote for a Wash & Detail service, including all of our different tiers of service. The quote will return with a checkout link, which you should redirect the customer towards. Once the customer has paid, a service order will be created with the details of the quote.

Attaching a deal to a quote will allow you to track all services related to that specific deal. The final invoice for the deal will include this quote, but will state that it was paid for separately.

Create Quote
{
  "type": "wash-&-detail",
  "services": ["basic"], // basic, wax, deep-clean, full-detail
  "vin": "WP0AF2A99KS165242"
}

Example Response
{
  "id": "quote_Bn7Y7c",
  "status": "awaiting-payment",
  "estimatedTime": "2024-01-01T12:00:00Z",
  "checkoutLink": "https://checkout.driv.ly/quote_Bn7Y7c",
  "paid": false,
  "total": 79,
  "items": [
    {
      "service": "wash-&-detail",
      "price": 79,
      "name": "Basic Wash & Detail",
      "description": "Standard wash and detail for WP0AF2A99KS165242"
    }
  ]
}

Upon payment, a service order will be generated with all pertinent details and an estimated completion time. Progress of the service order can be monitored using webhooks, ensuring timely updates throughout the wash and detail process.

Order Wash & Detail

Creating a service order for wash and detail services allows you to schedule, and pay for the service directly. This will create a service order which can be used to track progress and monitor costs.

For service orders, attaching a deal is highly recommended as this will allow you to keep all pending invoices in one place. The final invoice for the deal will include this order, but is rolled up into the total cost of the deal.

To place an order, you can submit a request with the following information:

Create Order
{
  "type": "wash-&-detail",
  "services": ["basic"], // basic, wax, deep-clean, full-detail
  "vin": "WP0AF2A99KS165242",
  "deal": "deal_Tn7Y7c"
}

Example Response
{
  "id": "order_fcx8YdP8Yd1xBH",
  "deal": "deal_Tn7Y7c",
  "status": "pending",
  "estimatedTime": "2024-01-01T12:00:00Z",
  "receiptLink": "https://checkout.driv.ly/order_fcx8YdP8Yd1xBH",
  "paid": true,
  "total": 79,
  "items": [
    {
      "service": "wash-&-detail",
      "price": 79,
      "name": "Basic Wash & Detail",
      "description": "Standard wash and detail for WP0AF2A99KS165242"
    }
  ]
}

You can keep up to date with the progress of your service order by using webhooks, ensuring you’re always up-to-date on the progress of your vehicle’s wash and detail service.

Typical Progression

Lets go over the typical progression of a wash and detail service order. While these steps are typical, there may be issues, delays, or other factors that can affect the progression of your service order.

If any problems arise, the service order’s status will be updated to either delayed or canceled, and you will be notified of the issue via email and webhook.

After payment is successful

A service order is created with the details of your quote, including the estimated time and cost.

The service order will start in the pending status, this means that its just waiting for the team to pick up the vehicle, and start work.

After some time has passed

The service provider will begin working on your vehicle, ensuring it receives the care it needs.

The service order will be updated to include the status of the service, moving from pending to in-progress.

Work is completed

Once the service is completed, the service order will be updated to reflect the status of the service.

After work is completed, the service order will be updated to include the status of the service, moving from in-progress to completed.

Webhooks

service.created - This event is triggered when a service order is created, providing you with the details of the order:

{
  "event": "service.created",
  "type": "wash-&-detail",
  "data": {
    "id": "order_fcx8YdP8Yd1xBH",
    "deal": "deal_Tn7Y7c",
    "status": "pending", // pending, in-progress, completed, delayed, canceled
    "estimatedTime": "2024-01-01T12:00:00Z",
    "receiptLink": "https://checkout.driv.ly/order_fcx8YdP8Yd1xBH",
    "paid": true,
    "total": 79,
    "items": [
      {
        "service": "wash-&-detail",
        "price": 79,
        "name": "Basic Wash & Detail",
        "description": "Standard wash and detail for WP0AF2A99KS165242"
      }
    ],
    "history": [
      // An Array to show the keys changed and when
      {
        "status": "pending",
        "paid": true,
        "time": "2024-01-01T12:00:00Z"
      }
    ]
  }
}

service.updated - This event is triggered when a your order is updated, for example, when we start work on the vehicle, or when the service has an issue:

{
  "event": "service.updated",
  "type": "wash-&-detail",
  "data": {
    "id": "order_fcx8YdP8Yd1xBH",
    "deal": "deal_Tn7Y7c",
    "status": "in-progress",
    "estimatedTime": "2024-01-01T12:00:00Z",
    "receiptLink": "https://checkout.driv.ly/order_fcx8YdP8Yd1xBH",
    "paid": true,
    "total": 79,
    "items": [
      {
        "service": "wash-&-detail",
        "price": 79,
        "name": "Basic Wash & Detail",
        "description": "Standard wash and detail for WP0AF2A99KS165242"
      }
    ],
    "history": [
      {
        "status": "pending",
        "paid": true,
        "time": "2024-01-01T12:00:00Z"
      },
      {
        "status": "in-progress",
        "time": "2024-01-02T12:00:00Z"
      }
    ]
  }
}

service.completed - This event is triggered when a service order is completed:

{
  "event": "service.completed",
  "type": "wash-&-detail",
  "data": {
    "id": "order_fcx8YdP8Yd1xBH",
    "deal": "deal_Tn7Y7c",
    "status": "completed",
    "estimatedTime": "2024-01-01T12:00:00Z",
    "receiptLink": "https://checkout.driv.ly/order_fcx8YdP8Yd1xBH",
    "paid": true,
    "total": 79,
    "items": [
      {
        "service": "wash-&-detail",
        "price": 79,
        "name": "Basic Wash & Detail",
        "description": "Standard wash and detail for WP0AF2A99KS165242"
      }
    ],
    "history": [
      {
        "status": "pending",
        "paid": true,
        "time": "2024-01-01T12:00:00Z"
      },
      {
        "status": "in-progress",
        "time": "2024-01-02T12:00:00Z"
      },
      {
        "status": "completed",
        "time": "2024-01-03T12:00:00Z"
      }
    ]
  }
}

Next Steps

Ready to get started with Wash & Detail API?

Quote – Wash & Detail

Quote wash and detail services

Order – Wash & Detail

Order wash and detail services

Services

Guides

API Reference

Overview

Workflows

Quote Wash & Detail

Order Wash & Detail

Typical Progression

Webhooks

Next Steps

Quote – Wash & Detail

Order – Wash & Detail

Services

Guides

API Reference

​Overview

​Workflows

​Quote Wash & Detail

​Order Wash & Detail

​Typical Progression

​Webhooks

​Next Steps

Quote – Wash & Detail

Order – Wash & Detail

Overview

Workflows

Quote Wash & Detail

Order Wash & Detail

Typical Progression

Webhooks

Next Steps