URL Expired

The URL for this request expired after 30 days.

id

integer

required

The id of the dealership

sort

string

enum

The sort order for each sort field MUST be ascending unless it is prefixed with a minus (U+002D HYPHEN-MINUS, "-"), in which case it MUST be descending.

actual_pickup_atlocation_sequencecheduled_pickup_atcreated_atstatus

Allowed:

actual_pickup_at``location_sequence``scheduled_pickup_at``created_at``status

open

boolean

Filter contracts to those that are open or closed today. Default (no value) returns both.

truefalse

status

array of strings

Filter contracts based on the status values provided

status

Allowed:

Booked``Pending``Started

ADD string

columns

string

Comma-separated list of columns to include in the CSV response

per_page

integer

required

Number of records returned in a collection in the response

page

integer

required

Page number returned from the collection based on the total records and records per response

api-version

integer

required

Target API version

accept

string

enum

Defaults to application/json

Generated from available response content types

application/jsontext/csv

Allowed:

application/json``text/csv

``200 Success

array of objects

object

id

integer

required

database id of the contract

ccpa

boolean

required

Customers CCPA status, deleted or not deleted

confirmation_token

string

required

also referred to as contract id

contactless

boolean

required

determines whether a contract's agreement is being signed contactlessly or not

location_sequence

integer

required

sequence id of the contract for its location

status

string | null

enum

required

current state of the contract

booked``cancelled``pending_agreement``started``finished``no_showed

created_at

date-time

required

time at which the contract was created

actual_dropoff_at

date-time | null

required

time at which the vehicle was dropped off, also indicates the contract finish time

actual_pickup_at

date-time | null

required

time at which the vehicle was picked up, also indicates the contract start time

days_on_loan

integer | null

required

number of days the vehicle has been out on loan (diff between now and actual_pickup_at, rounded up)

vehicle_stock_number

string | null

required

the attached vehicle's stock number, nil if no vehicle attached

vehicle_license

string | null

required

the attached vehicle's license plate number, nil if no vehicle attached

vin

string | null

required

the attached vehicle's VIN, nil if no vehicle attached

service_vehicle_id

string | null

required

the service vehicle's VIN

repair_order

string | null

required

linked repair order number, if present

purchase_order

string | null

required

linked purchase order number, if present

booking_application

string | null

required

Client application type that created the reservation (e.g. web, iphone-appstore, scheduler).

booking_channel

string | null

required

Partner integration source for the booking (e.g. mykaarma, xtime, redcap, toyota-oneapp) or dealerware for Dealerware-native bookings.

service_advisor_name

string | null

required

first and last name of the service advisor linked to contract

customer_name

string | null

required

first and last name of the customer linked to the contract

customer_profile_complete

boolean | null

required

indication of whether the customer's profile is complete and eligible to start a contract

vehicle_make

string | null

required

the automobile manufacturer

vehicle_model

string | null

required

the vehicle model name

vehicle_year

integer | null

required

the year the vehicle was manufactured

signed

boolean

required

indicates whether or not the contract has been signed

scheduled_pickup_at

date-time

required

the time the customer has scheduled to pick up the vehicle

scheduled_dropoff_at

date-time

required

the time the customer has scheduled to drop off the vehicle

fleet_name

string

required

The name of the vehicle group that is assigned to the contract

links

object

required

links object

``401 Unauthorized

``403 Forbidden

``404 Not found

``406 Not Acceptable

Updated3 months ago

ShellNodeRubyPHPPython

Bearer

Base URL

https://api.dealerware.com/admin/dealerships/{id}/contracts/manifest

xxxxxxxxxx

curl --request GET \

--url https://api.dealerware.com/admin/dealerships/id/contracts/manifest \
     --header 'accept: application/json'

xxxxxxxxxx

[

{

"id": 42,

"ccpa": true,

"confirmation_token": "7713738FG3",

"contactless": true,

"location_sequence": 42,

"status": "booked",

"created_at": "2020-06-15T20:12:26Z",

"actual_dropoff_at": "2020-06-17T20:12:26Z",

"actual_pickup_at": "2020-06-15T20:12:26Z",

"days_on_loan": 4,

"vehicle_stock_number": "ABC123",

"vehicle_license": "ABC 123",

"vin": "1G1JC524417418958",

"service_vehicle_id": "1G1JC524417418958",

"repair_order": "ABC123",

"purchase_order": "PO123",

"booking_application": "scheduler",

"booking_channel": "mykaarma",

"service_advisor_name": "Walter Skinner",

"customer_name": "Fox Mulder",

"customer_profile_complete": true,

"vehicle_make": "Audi",

"vehicle_model": "A2",

"vehicle_year": 2022,

"signed": true,

"scheduled_pickup_at": "2020-06-15T20:12:26Z",

"scheduled_dropoff_at": "2020-06-15T20:12:26Z",

"fleet_name": "Courtesy",

"links": {

"vehicle": {

"id": 2,

"href": "https://api.dw-tst.com/admin/some_resources/2"

},

"employee": {

"id": 2,

"href": "https://api.dw-tst.com/admin/some_resources/2"

},

"customer": {

"id": 2,

"href": "https://api.dw-tst.com/admin/some_resources/2"

},

"fleet": {

"id": 2,

"href": "https://api.dw-tst.com/admin/some_resources/2"

}

}

}

]