Query the manifest scope (open and closed today) of contracts for a dealership
| Time | Status | User Agent | |
|---|---|---|---|
| Make a request to see history. |
URL Expired
The URL for this request expired after 30 days.
API Parameters
Required Parameters
- id (integer): The id of the dealership
- q (string): Query parameter to search against indexed fields on Contract
- api-version (integer): Target API version
Response Structure
200 Success
- array of objects
object
- id (integer): database id of the contract
- ccpa (boolean): Customers CCPA status, deleted or not deleted
- confirmation_token (string): also referred to as contract id
- contactless (boolean): determines whether a contract's agreement is being signed contactlessly or not
- location_sequence (integer): sequence id of the contract for its location
- status (string | null): current state of the contract (e.g.,
booked,cancelled,pending_agreement,started,finished,no_showed) - created_at (date-time): time at which the contract was created
- actual_dropoff_at (date-time | null): time at which the vehicle was dropped off
- actual_pickup_at (date-time | null): time at which the vehicle was picked up
- days_on_loan (integer | null): number of days the vehicle has been out on loan
- vehicle_stock_number (string | null): the attached vehicle's stock number
- vehicle_license (string | null): the attached vehicle's license plate number
- vin (string | null): the attached vehicle's VIN
- service_vehicle_id (string | null): the service vehicle's VIN
- repair_order (string | null): linked repair order number, if present
- purchase_order (string | null): linked purchase order number, if present
- booking_application (string | null): Client application type that created the reservation
- booking_channel (string | null): Partner integration source for the booking
- service_advisor_name (string | null): first and last name of the service advisor linked to contract
- customer_name (string | null): first and last name of the customer linked to the contract
- customer_profile_complete (boolean | null): indication of whether the customer's profile is complete and eligible to start a contract
- vehicle_make (string | null): the automobile manufacturer
- vehicle_model (string | null): the vehicle model name
- vehicle_year (integer | null): the year the vehicle was manufactured
- signed (boolean): indicates whether or not the contract has been signed
- scheduled_pickup_at (date-time): the time the customer has scheduled to pick up the vehicle
- scheduled_dropoff_at (date-time): the time the customer has scheduled to drop off the vehicle
- fleet_name (string): The name of the vehicle group that is assigned to the contract
- links (object): links object
Example Response
[
{
"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"
}
}
}
]