URL Expired

The URL for this request expired after 30 days.

id

integer

required

The id of the dealership

status_in

array of strings

Include only Contracts with these statuses (booked, cancelled, pending_agreement, started, finished or no_showed)

status_in ADD string

status_not_in

array of strings

Include Contracts that are not in these statuses (booked, cancelled, pending_agreement, started, finished or no_showed)

status_not_in ADD string

start_at

date-time

Include Contracts created after or on this date and time

end_at

date-time

Include Contracts created before or on this date and time

occurs_during

string

A string containing the from date and to date separated by a comma

fleet_ids

array of numbers

Comma separated list of integers (Fleet ID)

fleet_ids ADD number

agreement_id

number

Include Contracts with this Agreement ID

types

array of strings

Include Contracts with this type (loaner or rental)

types ADD string

booking_channels

array of strings

Comma separated list of booking channel slugs (e.g. dealerware, xtime, mykaarma)

booking_channels ADD string

page

number

The page to be fetched, by default 1

per_page

number

Number of items per page to be fetched, by default 30

api-version

integer

required

Target API version

``200 Success

array of objects

object

id

number

contract_type

string

This is either a contract or reservation

status

string

booked, cancelled, pending_agreement, started, finished or no_showed

created_at

string

scheduled_pickup_at

string

scheduled_dropoff_at

string

actual_pickup_at

string | null

actual_dropoff_at

string | null

service_advisor

string | null

vehicle_id

number | null

fleet_id

number

calendar_group

string

Either scheduled or unscheduled

has_valet_task

boolean

true if the Contract has at least one valet task

task_ids

array of numbers

service_vehicle_id

string | null

repair_order

string | null

purchase_order

string | null

The optional purchase order number associated with this contract

booking_application

string | null

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

booking_channel

string | null

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

agreement

object

agreement object

customer

object

customer 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}/calendar/contracts

xxxxxxxxxx

curl --request GET \

--url https://api.dealerware.com/admin/dealerships/id/calendar/contracts \

--header 'accept: application/json'

xxxxxxxxxx

[

{

"id": 1,

"contract_type": "contract",

"status": "booked",

"created_at": "2022-11-15T12:01:40-05:00",

"scheduled_pickup_at": "2022-11-15T12:01:40-05:00",

"scheduled_dropoff_at": "2022-11-15T12:01:40-05:00",

"actual_pickup_at": "2022-11-15T12:01:40-05:00",

"actual_dropoff_at": "2022-11-15T12:01:40-05:00",

"service_advisor": "Ted Smith",

"vehicle_id": 1,

"fleet_id": 2,

"calendar_group": "unscheduled",

"has_valet_task": true,

"task_ids": [

1,

2

],

"service_vehicle_id": "123abc",

"repair_order": "abc123",

"purchase_order": "PO123",

"booking_application": "scheduler",

"booking_channel": "mykaarma",

"agreement": {

"id": 1,

"insurance_form": "Custom"

},

"customer": {

"id": 1,

"customer_profile_complete": true,

"full_name": "Sally Smith"

}

}

]

Updated3 months ago