Create a new Service Order

curl --request POST \
  --url https://commerce.driv.ly/api/serviceOrders \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "name": "<string>",
  "type": [],
  "customer": [
    123
  ],
  "serviceQuotes": 123,
  "paymentLink": "<string>",
  "vin": 123,
  "error": "<string>",
  "orderId": "<string>",
  "price": "<string>",
  "rush": true,
  "attachments": [
    123
  ],
  "quoteExpiration": "<string>",
  "ordered": "<string>",
  "start": "<string>",
  "due": "<string>",
  "consignor": 123,
  "billTo": 123,
  "origin": 123,
  "destination": 123,
  "deals": [
    123
  ],
  "orderLink": "<string>",
  "tenant": [
    123
  ]
}
'

import requests

url = "https://commerce.driv.ly/api/serviceOrders"

payload = {
    "updatedAt": "<string>",
    "createdAt": "<string>",
    "name": "<string>",
    "type": [],
    "customer": [123],
    "serviceQuotes": 123,
    "paymentLink": "<string>",
    "vin": 123,
    "error": "<string>",
    "orderId": "<string>",
    "price": "<string>",
    "rush": True,
    "attachments": [123],
    "quoteExpiration": "<string>",
    "ordered": "<string>",
    "start": "<string>",
    "due": "<string>",
    "consignor": 123,
    "billTo": 123,
    "origin": 123,
    "destination": 123,
    "deals": [123],
    "orderLink": "<string>",
    "tenant": [123]
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    updatedAt: '<string>',
    createdAt: '<string>',
    name: '<string>',
    type: [],
    customer: [123],
    serviceQuotes: 123,
    paymentLink: '<string>',
    vin: 123,
    error: '<string>',
    orderId: '<string>',
    price: '<string>',
    rush: true,
    attachments: [123],
    quoteExpiration: '<string>',
    ordered: '<string>',
    start: '<string>',
    due: '<string>',
    consignor: 123,
    billTo: 123,
    origin: 123,
    destination: 123,
    deals: [123],
    orderLink: '<string>',
    tenant: [123]
  })
};

fetch('https://commerce.driv.ly/api/serviceOrders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://commerce.driv.ly/api/serviceOrders",
  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([
    'updatedAt' => '<string>',
    'createdAt' => '<string>',
    'name' => '<string>',
    'type' => [
        
    ],
    'customer' => [
        123
    ],
    'serviceQuotes' => 123,
    'paymentLink' => '<string>',
    'vin' => 123,
    'error' => '<string>',
    'orderId' => '<string>',
    'price' => '<string>',
    'rush' => true,
    'attachments' => [
        123
    ],
    'quoteExpiration' => '<string>',
    'ordered' => '<string>',
    'start' => '<string>',
    'due' => '<string>',
    'consignor' => 123,
    'billTo' => 123,
    'origin' => 123,
    'destination' => 123,
    'deals' => [
        123
    ],
    'orderLink' => '<string>',
    'tenant' => [
        123
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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 := "https://commerce.driv.ly/api/serviceOrders"

	payload := strings.NewReader("{\n  \"updatedAt\": \"<string>\",\n  \"createdAt\": \"<string>\",\n  \"name\": \"<string>\",\n  \"type\": [],\n  \"customer\": [\n    123\n  ],\n  \"serviceQuotes\": 123,\n  \"paymentLink\": \"<string>\",\n  \"vin\": 123,\n  \"error\": \"<string>\",\n  \"orderId\": \"<string>\",\n  \"price\": \"<string>\",\n  \"rush\": true,\n  \"attachments\": [\n    123\n  ],\n  \"quoteExpiration\": \"<string>\",\n  \"ordered\": \"<string>\",\n  \"start\": \"<string>\",\n  \"due\": \"<string>\",\n  \"consignor\": 123,\n  \"billTo\": 123,\n  \"origin\": 123,\n  \"destination\": 123,\n  \"deals\": [\n    123\n  ],\n  \"orderLink\": \"<string>\",\n  \"tenant\": [\n    123\n  ]\n}")

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

	req.Header.Add("Authorization", "<api-key>")
	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("https://commerce.driv.ly/api/serviceOrders")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"updatedAt\": \"<string>\",\n  \"createdAt\": \"<string>\",\n  \"name\": \"<string>\",\n  \"type\": [],\n  \"customer\": [\n    123\n  ],\n  \"serviceQuotes\": 123,\n  \"paymentLink\": \"<string>\",\n  \"vin\": 123,\n  \"error\": \"<string>\",\n  \"orderId\": \"<string>\",\n  \"price\": \"<string>\",\n  \"rush\": true,\n  \"attachments\": [\n    123\n  ],\n  \"quoteExpiration\": \"<string>\",\n  \"ordered\": \"<string>\",\n  \"start\": \"<string>\",\n  \"due\": \"<string>\",\n  \"consignor\": 123,\n  \"billTo\": 123,\n  \"origin\": 123,\n  \"destination\": 123,\n  \"deals\": [\n    123\n  ],\n  \"orderLink\": \"<string>\",\n  \"tenant\": [\n    123\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://commerce.driv.ly/api/serviceOrders")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"updatedAt\": \"<string>\",\n  \"createdAt\": \"<string>\",\n  \"name\": \"<string>\",\n  \"type\": [],\n  \"customer\": [\n    123\n  ],\n  \"serviceQuotes\": 123,\n  \"paymentLink\": \"<string>\",\n  \"vin\": 123,\n  \"error\": \"<string>\",\n  \"orderId\": \"<string>\",\n  \"price\": \"<string>\",\n  \"rush\": true,\n  \"attachments\": [\n    123\n  ],\n  \"quoteExpiration\": \"<string>\",\n  \"ordered\": \"<string>\",\n  \"start\": \"<string>\",\n  \"due\": \"<string>\",\n  \"consignor\": 123,\n  \"billTo\": 123,\n  \"origin\": 123,\n  \"destination\": 123,\n  \"deals\": [\n    123\n  ],\n  \"orderLink\": \"<string>\",\n  \"tenant\": [\n    123\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "doc": {
    "updatedAt": "<string>",
    "createdAt": "<string>",
    "name": "<string>",
    "type": [],
    "customer": [
      123
    ],
    "serviceQuotes": 123,
    "paymentLink": "<string>",
    "vin": 123,
    "error": "<string>",
    "orderId": "<string>",
    "price": "<string>",
    "rush": true,
    "attachments": [
      123
    ],
    "quoteExpiration": "<string>",
    "ordered": "<string>",
    "start": "<string>",
    "due": "<string>",
    "consignor": 123,
    "billTo": 123,
    "origin": 123,
    "destination": 123,
    "deals": [
      123
    ],
    "orderLink": "<string>",
    "tenant": [
      123
    ]
  },
  "message": "<string>"
}

POST

serviceOrders

Create a new Service Order

curl --request POST \
  --url https://commerce.driv.ly/api/serviceOrders \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "name": "<string>",
  "type": [],
  "customer": [
    123
  ],
  "serviceQuotes": 123,
  "paymentLink": "<string>",
  "vin": 123,
  "error": "<string>",
  "orderId": "<string>",
  "price": "<string>",
  "rush": true,
  "attachments": [
    123
  ],
  "quoteExpiration": "<string>",
  "ordered": "<string>",
  "start": "<string>",
  "due": "<string>",
  "consignor": 123,
  "billTo": 123,
  "origin": 123,
  "destination": 123,
  "deals": [
    123
  ],
  "orderLink": "<string>",
  "tenant": [
    123
  ]
}
'

import requests

url = "https://commerce.driv.ly/api/serviceOrders"

payload = {
    "updatedAt": "<string>",
    "createdAt": "<string>",
    "name": "<string>",
    "type": [],
    "customer": [123],
    "serviceQuotes": 123,
    "paymentLink": "<string>",
    "vin": 123,
    "error": "<string>",
    "orderId": "<string>",
    "price": "<string>",
    "rush": True,
    "attachments": [123],
    "quoteExpiration": "<string>",
    "ordered": "<string>",
    "start": "<string>",
    "due": "<string>",
    "consignor": 123,
    "billTo": 123,
    "origin": 123,
    "destination": 123,
    "deals": [123],
    "orderLink": "<string>",
    "tenant": [123]
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    updatedAt: '<string>',
    createdAt: '<string>',
    name: '<string>',
    type: [],
    customer: [123],
    serviceQuotes: 123,
    paymentLink: '<string>',
    vin: 123,
    error: '<string>',
    orderId: '<string>',
    price: '<string>',
    rush: true,
    attachments: [123],
    quoteExpiration: '<string>',
    ordered: '<string>',
    start: '<string>',
    due: '<string>',
    consignor: 123,
    billTo: 123,
    origin: 123,
    destination: 123,
    deals: [123],
    orderLink: '<string>',
    tenant: [123]
  })
};

fetch('https://commerce.driv.ly/api/serviceOrders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://commerce.driv.ly/api/serviceOrders",
  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([
    'updatedAt' => '<string>',
    'createdAt' => '<string>',
    'name' => '<string>',
    'type' => [
        
    ],
    'customer' => [
        123
    ],
    'serviceQuotes' => 123,
    'paymentLink' => '<string>',
    'vin' => 123,
    'error' => '<string>',
    'orderId' => '<string>',
    'price' => '<string>',
    'rush' => true,
    'attachments' => [
        123
    ],
    'quoteExpiration' => '<string>',
    'ordered' => '<string>',
    'start' => '<string>',
    'due' => '<string>',
    'consignor' => 123,
    'billTo' => 123,
    'origin' => 123,
    'destination' => 123,
    'deals' => [
        123
    ],
    'orderLink' => '<string>',
    'tenant' => [
        123
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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 := "https://commerce.driv.ly/api/serviceOrders"

	payload := strings.NewReader("{\n  \"updatedAt\": \"<string>\",\n  \"createdAt\": \"<string>\",\n  \"name\": \"<string>\",\n  \"type\": [],\n  \"customer\": [\n    123\n  ],\n  \"serviceQuotes\": 123,\n  \"paymentLink\": \"<string>\",\n  \"vin\": 123,\n  \"error\": \"<string>\",\n  \"orderId\": \"<string>\",\n  \"price\": \"<string>\",\n  \"rush\": true,\n  \"attachments\": [\n    123\n  ],\n  \"quoteExpiration\": \"<string>\",\n  \"ordered\": \"<string>\",\n  \"start\": \"<string>\",\n  \"due\": \"<string>\",\n  \"consignor\": 123,\n  \"billTo\": 123,\n  \"origin\": 123,\n  \"destination\": 123,\n  \"deals\": [\n    123\n  ],\n  \"orderLink\": \"<string>\",\n  \"tenant\": [\n    123\n  ]\n}")

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

	req.Header.Add("Authorization", "<api-key>")
	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("https://commerce.driv.ly/api/serviceOrders")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"updatedAt\": \"<string>\",\n  \"createdAt\": \"<string>\",\n  \"name\": \"<string>\",\n  \"type\": [],\n  \"customer\": [\n    123\n  ],\n  \"serviceQuotes\": 123,\n  \"paymentLink\": \"<string>\",\n  \"vin\": 123,\n  \"error\": \"<string>\",\n  \"orderId\": \"<string>\",\n  \"price\": \"<string>\",\n  \"rush\": true,\n  \"attachments\": [\n    123\n  ],\n  \"quoteExpiration\": \"<string>\",\n  \"ordered\": \"<string>\",\n  \"start\": \"<string>\",\n  \"due\": \"<string>\",\n  \"consignor\": 123,\n  \"billTo\": 123,\n  \"origin\": 123,\n  \"destination\": 123,\n  \"deals\": [\n    123\n  ],\n  \"orderLink\": \"<string>\",\n  \"tenant\": [\n    123\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://commerce.driv.ly/api/serviceOrders")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"updatedAt\": \"<string>\",\n  \"createdAt\": \"<string>\",\n  \"name\": \"<string>\",\n  \"type\": [],\n  \"customer\": [\n    123\n  ],\n  \"serviceQuotes\": 123,\n  \"paymentLink\": \"<string>\",\n  \"vin\": 123,\n  \"error\": \"<string>\",\n  \"orderId\": \"<string>\",\n  \"price\": \"<string>\",\n  \"rush\": true,\n  \"attachments\": [\n    123\n  ],\n  \"quoteExpiration\": \"<string>\",\n  \"ordered\": \"<string>\",\n  \"start\": \"<string>\",\n  \"due\": \"<string>\",\n  \"consignor\": 123,\n  \"billTo\": 123,\n  \"origin\": 123,\n  \"destination\": 123,\n  \"deals\": [\n    123\n  ],\n  \"orderLink\": \"<string>\",\n  \"tenant\": [\n    123\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "doc": {
    "updatedAt": "<string>",
    "createdAt": "<string>",
    "name": "<string>",
    "type": [],
    "customer": [
      123
    ],
    "serviceQuotes": 123,
    "paymentLink": "<string>",
    "vin": 123,
    "error": "<string>",
    "orderId": "<string>",
    "price": "<string>",
    "rush": true,
    "attachments": [
      123
    ],
    "quoteExpiration": "<string>",
    "ordered": "<string>",
    "start": "<string>",
    "due": "<string>",
    "consignor": 123,
    "billTo": 123,
    "origin": 123,
    "destination": 123,
    "deals": [
      123
    ],
    "orderLink": "<string>",
    "tenant": [
      123
    ]
  },
  "message": "<string>"
}

Usage with the Drivly SDK

Make sure you install our SDK first. You can find out how, and more here.

import { SDK } from '@drivly/commerce'
import type { serviceOrders } from '@drivly/commerce'

const sdk = new SDK(...)

const serviceOrders = await sdk.serviceOrders.create(data: serviceOrders): Promise<serviceOrders>

Authorizations

Authorization

string

header

required

Query Parameters

depth

number

number of levels to automatically populate relationships and uploads

locale

string

retrieves document(s) in a specific locale

fallback-locale

string

specifies a fallback locale if no locale value exists

Body

application/json

updatedAt

string

required

createdAt

string

required

name

string | null

type

enum<string>[] | null

Available options:

Condition Inspection,

Last Mile Delivery,

Long Haul Transport,

Mechanical Inspection,

Post Sale Inspection,

Pre-Paid Maintenance,

Pre-Purchase Inspection,

Safety Inspection,

Vehicle Service Contract,

Wash And Detail

customer

(number | Customer · object)[] | null

serviceQuotes

paymentLink

string | null

vin

status

enum<string> | null

Available options:

Quoted,

Pending,

In Review,

Active,

Dispatched,

En Route,

Complete,

Hold,

Cancel,

Error

error

string | null

orderId

string | null

price

string | null

rush

boolean | null

attachments

(number | Attachment · object)[] | null

quoteExpiration

string | null

ordered

string | null

start

string | null

due

string | null

consignor

billTo

origin

destination

deals

(number | Deal · object)[] | null

orderLink

string | null

tenant

(number | Tenant · object)[] | null

Response

200 - application/json

doc

ServiceOrder · object

required

Show child attributes

message

string

required

Commerce

API Reference

Create a new Service Order

Authorizations

Query Parameters

Body

Response