Skip to main content
POST
/
jobs
Create job and trigger dispatch (customer only)
curl --request POST \
  --url http://localhost:3000/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "service_category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pickup_address": "<string>",
  "pickup_lat": 123,
  "pickup_lng": 123,
  "vehicle_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "photo_urls": [
    "<string>"
  ]
}
'
import requests

url = "http://localhost:3000/jobs"

payload = {
"service_category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pickup_address": "<string>",
"pickup_lat": 123,
"pickup_lng": 123,
"vehicle_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"photo_urls": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
service_category_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
pickup_address: '<string>',
pickup_lat: 123,
pickup_lng: 123,
vehicle_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
description: '<string>',
photo_urls: ['<string>']
})
};

fetch('http://localhost:3000/jobs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/jobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'service_category_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'pickup_address' => '<string>',
'pickup_lat' => 123,
'pickup_lng' => 123,
'vehicle_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'description' => '<string>',
'photo_urls' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "http://localhost:3000/jobs"

payload := strings.NewReader("{\n \"service_category_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"pickup_address\": \"<string>\",\n \"pickup_lat\": 123,\n \"pickup_lng\": 123,\n \"vehicle_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\",\n \"photo_urls\": [\n \"<string>\"\n ]\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("http://localhost:3000/jobs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"service_category_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"pickup_address\": \"<string>\",\n \"pickup_lat\": 123,\n \"pickup_lng\": 123,\n \"vehicle_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\",\n \"photo_urls\": [\n \"<string>\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:3000/jobs")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"service_category_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"pickup_address\": \"<string>\",\n \"pickup_lat\": 123,\n \"pickup_lng\": 123,\n \"vehicle_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\",\n \"photo_urls\": [\n \"<string>\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vehicle_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "service_category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pickup_address": "<string>",
  "pickup_lat": 123,
  "pickup_lng": 123,
  "description": "<string>",
  "estimated_price": 123,
  "final_price": 123,
  "base_price": 123,
  "cancellation_fee": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "mechanic_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "photo_urls": [
    "<string>"
  ],
  "cancel_reason": "<string>",
  "hms_room_id": "<string>",
  "disputed_at": "2023-11-07T05:31:56Z",
  "resolved_at": "2023-11-07T05:31:56Z"
}
{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"errors": {}
}
}
{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"errors": {}
}
}
{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"errors": {}
}
}

Authorizations

Authorization
string
header
required

JWT access token from /auth/verify-otp

Body

application/json
service_category_id
string<uuid>
required
pickup_address
string
required
pickup_lat
number
required
pickup_lng
number
required
vehicle_id
string<uuid>
description
string
photo_urls
string<uri>[]

Response

Job created

id
string<uuid>
customer_id
string<uuid>
vehicle_id
string<uuid>
service_category_id
string<uuid>
status
enum<string>
Available options:
pending,
dispatching,
accepted,
en_route,
arrived,
in_progress,
completed,
paid,
cancelled,
no_mechanic_found,
disputed,
resolved
pickup_address
string
pickup_lat
number

Latitude of pickup location (-90 to 90)

pickup_lng
number

Longitude of pickup location (-180 to 180)

description
string | null
estimated_price
number | null
final_price
number | null
base_price
number | null
cancellation_fee
number | null
created_at
string<date-time>
updated_at
string<date-time>
mechanic_profile_id
string<uuid>
photo_urls
string<uri>[]
cancel_reason
string | null
hms_room_id
string

100ms room ID for in-job audio call (null until first comms request)

disputed_at
string<date-time>
resolved_at
string<date-time>