MOB-API

Admin
Agreement Toggles
Agreements
Availability
- Load dealership information to the Availability Service (AVL)post
Availability 2.0
- Get availability for a Fleet/Programget
- Get availability for a Fleet/Program with intervalsget
Billing
- Returns the historical Pricing Settings objects associated with a fleetget
- Creates effective Pricing Setting associated with a fleetpost
Contactless
- Returns Contactless Contract/Driver Informationget
- Create a Signature Image for the Driverpost
Contracts
Customers
Dealerships
Drivers
Employees
Employer Info
Fleets
Fleet Settings
Geolocation
- Returns the distance between 2 addresses and whether the distance falls inside a radial boundpost
- Returns the contexts against vins that includes location, offlot radius and contract statusget
Insurance
Issues
- Deletes an issuedelete
- Resolves an issueput
Managed Toggles
Oem Infos
Payment Provider Configuration
- Returns the token and provider name available for the authenticated userget
Recalls
Roles
- Returns the grantable roles for a given dealershipget
SCBA Booking Flow
ScheduleNote
- Create or Update a note attached to a reservation in our Schedule componentpost
Settings
- /admin/dealerships/{id}/fleet_settingsget
Telematics
Tenancy
Toggle Groups
Toll Providers
User
Users
Vehicles
Parking Lot
- Parking Lot Ingestionpost
- Create a insurance for a customerpost
- Update insurance for a customerput

MOB-API

Admin
Agreement Toggles
Agreements
Availability
- Load dealership information to the Availability Service (AVL)post
Availability 2.0
- Get availability for a Fleet/Programget
- Get availability for a Fleet/Program with intervalsget
Billing
- Returns the historical Pricing Settings objects associated with a fleetget
- Creates effective Pricing Setting associated with a fleetpost
Contactless
- Returns Contactless Contract/Driver Informationget
- Create a Signature Image for the Driverpost
Contracts
Customers
Dealerships
Drivers
Employees
Employer Info
Fleets
Fleet Settings
Geolocation
- Returns the distance between 2 addresses and whether the distance falls inside a radial boundpost
- Returns the contexts against vins that includes location, offlot radius and contract statusget
Insurance
Issues
- Deletes an issuedelete
- Resolves an issueput
Managed Toggles
Oem Infos
Payment Provider Configuration
- Returns the token and provider name available for the authenticated userget
Recalls
Roles
- Returns the grantable roles for a given dealershipget
SCBA Booking Flow
ScheduleNote
- Create or Update a note attached to a reservation in our Schedule componentpost
Settings
- /admin/dealerships/{id}/fleet_settingsget
Telematics
Tenancy
Toggle Groups
Toll Providers
User
Users
Vehicles
Parking Lot
- Parking Lot Ingestionpost
- Create a insurance for a customerpost
- Update insurance for a customerput

Fetch the manifest scope (open or closed today) of contracts for a dealership

get https://example.com/admin/dealerships/{id}/contracts/manifest

time	status	user agent
Retrieving recent requests…

Loading…

URL Expired

The URL for this request expired after 30 days.

Path Params

integer

required

The id of the dealership

Query Params

sort

string

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.

open

boolean

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

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

Headers

api-version

integer

required

Target API version

Responses

Response body

array of objects

object

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

status

string | null

current state of the contract

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, also indicates the contract finish time

actual_pickup_at

date-time | null

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

days_on_loan

integer | null

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

vehicle_stock_number

string | null

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

vehicle_license

string | null

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

vin

string | null

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

service_vehicle_id

string | null

the service vehicle's VIN

repair_order

string | null

linked repair order number, if present

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

Response body

object

message

string

code

integer

Response body

object

message

string

code

integer

Response body

object

message

string

code

integer

Response body

object

message

string

code

integer

Updated 1 day ago

Fetch the Payment Methods belonging to the given Customer

Query the manifest scope (open and closed today) of contracts for a dealership

Did this page help you?

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://example.com/admin/dealerships/id/contracts/manifest \
3
     --header 'accept: application/json'


xxxxxxxxxx
46
]
1
[
2
  {
3
    "id": 42,
4
    "ccpa": true,
5
    "confirmation_token": "7713738FG3",
6
    "contactless": true,
7
    "status": "booked",
8
    "created_at": "2020-06-15T20:12:26Z",
9
    "actual_dropoff_at": "2020-06-17T20:12:26Z",
10
    "actual_pickup_at": "2020-06-15T20:12:26Z",
11
    "days_on_loan": 4,
12
    "vehicle_stock_number": "ABC123",
13
    "vehicle_license": "ABC 123",
14
    "vin": "1G1JC524417418958",
15
    "service_vehicle_id": "1G1JC524417418958",
16
    "repair_order": "ABC123",
17
    "service_advisor_name": "Walter Skinner",
18
    "customer_name": "Fox Mulder",
19
    "customer_profile_complete": true,
20
    "vehicle_make": "Audi",
21
    "vehicle_model": "A2",
22
    "vehicle_year": 2022,
23
    "signed": true,
24
    "scheduled_pickup_at": "2020-06-15T20:12:26Z",
25
    "scheduled_dropoff_at": "2020-06-15T20:12:26Z",
26
    "fleet_name": "Courtesy",
27
    "links": {
28
      "vehicle": {
29
        "id": 2,

Updated 1 day ago

Fetch the Payment Methods belonging to the given Customer

Query the manifest scope (open and closed today) of contracts for a dealership

Did this page help you?

MOB-API
Admin
View Rental Agreement detailsget
Regenerate Rental Agreementput
Admin login endpointpost
Returns the Status for all vehicles at a given dealership on the Dashboard tablesget
/admin/contracts/{id}/rental_agreementsget
Generates a Contract's Rental Agreementpost
Creates a contactless text message associated with a contractpost
Agreement Toggles
Update the printed order of the fleet's Agreement Togglesput
Create a new Agreement Toggle for a given fleetpost
Return the Agreement Toggles scoped to the given fleet idget
Delete an Agreement Toggledelete
Update an Agreement Toggleput
Agreements
Retrieve a preview of the custom-mapped agreement that will be used for the dealership.get
Performs cleanup work to transition dealership to using a provider agreement. Should be called after uploading new agreement with Salesforce.post
Update mappings for an agreementput
Get existing mappings for an agreementget
Get all fields that can be mapped onto an agreementget
Availability
Load dealership information to the Availability Service (AVL)post
Availability 2.0
Get availability for a Fleet/Program with intervalsget
Get availability for a Fleet/Programget
Billing
Creates effective Pricing Setting associated with a fleetpost
Returns the historical Pricing Settings objects associated with a fleetget
Contactless
Create a Signature Image for the Driverpost
Returns Contactless Contract/Driver Informationget
Contracts
Manually start the given contract with superuser privileges, overriding the start dateput
Modify the given contract with superuser privilegespatch
Returns contactless contract dataget
Creates a new signature associated with a contactless contractpost
Fetch the fleets for a location, along with the contracts (within the given time range, all statuses) and vehicles for eachget
Fetch the manifest scope of contracts for a dealership with a pickup/dropoff time of the current dayget
Query the manifest scope (open and closed today) of contracts for a dealershipget
Fetch the manifest scope (open or closed today) of contracts for a dealershipget
Fetch the Payment Methods belonging to the given Customerget
Fetch the contracts for a customer at a particular dealershipget
Removes the Warranty from a Contractdelete
Update the Contract's Warrantyput
Creates a Warranty for a Contractpost
Returns a Warranty for a Contractget
Returns a list of available vehicles for a contract based on the provided queryget
Retrieves a list of available vehicles for the given contractget
Unassign the vehicle currently assigned to the given contractput
Assign a Vehicle to the Given Contractput
Finish the given Contractput
Start the Given Contractput
Cancel the Given Contractdelete
creates a additional payer pdf reciept.post
Fetch the available vehicle groups for a split billget
Generate split bill PDF for the given contractpost
Deletes the payment of the split bill of a given contractdelete
Creates a payment for the split bill of a given contractpost
Creates an adjustment of the specified amount on a contract's split billpost
Fetch the adjustment associated to a given contract's split billget
Deletes a split billdelete
Update the split bill associated with a given contractput
Creates a split bill that is associated with a given contractpost
Fetch the split bill associated to a given Contractget
Create a settlement attempt on the balance of the contractpost
Generate and fetch receipt PDF for the given contractpost
Fetch the pricing information of a given Contractget
Fetch the payments attached to a given Contractget
Update the payment method for the given contractput
Delete a note for a contractdelete
Update a note for a contractput
Add a note for a contractpost
Get the notes for a contractget
Fetch Details for needed information to begin a given contractget
Fetch the customer attached to a given Contractget
Create a billing adjustment (charge or credit) for the given contractpost
Fetch the available adjustments for a given contractget
Create a Driver attached to a given Contractpost
Get all Drivers attached to a given Contractget
Fetch the authorization amount for a given contractget
Get all Toggles attached to a given Contractget
Update Details for a Given Contractput
Fetch Details for a Given Contractget
Customers
Returns the Customer objects available to the authenticated user, whose names also match the query stringget
Finds a single Customer profile based on the given token and driver's license/email infopost
Sends an SMS to a new/existing Customer to create/update their Customer profilepost
Get cached profile information for a customerget
Returns the list of Customers associated with a dealership based on search queryget
Create a new customer associated with a dealershippost
Returns the list of Customers associated with a dealershipget
Deletes the list of Customers associated with the id's passed in body of request.delete
Creates the third party insurance verified account information for future lookuppost
Returns the third party verified insurance for a Customerget
Update a Customer's profileput
Returns a customers's profile detailsget
Dealerships
Agreement Group Deletedelete
Insurance Forms Listget
Gets the most recent rental agreementget
Add a new rental agreement to a locationpost
Agreement Group Updateput
Agreement Group Createpost
Agreement Group Listget
Returns a paginated list of Parking Lot objectsget
Returns a dealership IDget
Update a dealershipput
Gets Toggles per Dealership Agreementget
Disable dealership insurance verification enrollmentput
Enroll dealership in verified insurance integrationpost
Get list of dealerships enrolled in insurance verification integrationget
Gets Fleets Availability and Ratesget
Update the customer information for a reservationput
Get the customer information for a reservationget
Update a Reservation within a single endpointput
Create a Reservation within a single endpointpost
Create a new dealershippost
Returns the user roles for a given locationget
Returns the Dealership objects available to the authenticated user, whose names also match the query stringget
Gets all vehicles no matter the state for a dealerget
Returns the list of Vehicle objects associated with a dealership based on search queryget
Creates a new Vehicle for a Dealership and assigns it to a list of Fleetspost
Returns a paginated list of Vehicle objects associated with a dealershipget
Updates the dealership's settings - Available to customer support users only.put
Returns the dealership settingsget
Returns the list of Service Advisors associated with a dealershipget
Get Filtered and/or Sorted Dealership Report Transactions Datapost
Get Dealership Report Transactions Dataget
Get Dealership Report Summaryget
Get Dealership Report Revenue Dataget
Get Dealership Receivables Report Summaryget
Get Dealership Receivables Report Dataget
Get Dealership Report Vehicle Inventory Dataget
Returns the dealership specific or default set of KPIspost
Check the status of bulk onboarding vehicles by CSV, and return a big chunk of json response of the statusget
Bulk onboarding vehicles by uploading a CSV file, and return a list of results about success/errorpost
Creates a new fleet associated with a dealershippost
Returns the list of Fleet objects associated with a dealershipget
Returns a paginated list of Vehicle objects for the Calendarget
Returns a paginated list of Reservations or Contracts for a Dealership Calendarget
Sets Dealership bookable attribute to false – authorized users are controlled by a feature flagdelete
Set Dealership bookable attribute to true – authorized users are controlled by a feature flagpost
Get Dealership bookable attributeget
Get availability from a static start time for all cars in a dealership by day for every day between start and end, inclusiveget
Get availability from a static start time for all cars in a dealership by 30-minute interval for every interval between start and end, inclusiveget
Get availability for all cars in a dealership by day for every day between start and end, inclusiveget
Get availability for all cars in a dealership by 30-minute interval for every interval between start and end, inclusiveget
Returns the list of Agreements objects associated with a dealershipget
Updates the dealership addressput
Returns the dealership addressget
Updates the Dealership and/or its Fleets' Settingspatch
Returns the requested dealership object to the authenticated userget
Returns the Dealership objects available to the authenticated userget
Open Days
Updates Dealership Open Days and Business Hoursput
Drivers
Create a Signature Image for the Driverpost
Delete a Driverdelete
Update a Driver's detailsput
Get a Driver's detailsget
Employees
Returns the list of Employees associated with a dealership based on search queryget
Create a new employee associated with a dealershippost
Returns the list of Employees associated with a dealershipget
Update an employee's roles for a dealershipput
Returns an employee's roles for a dealershipget
Activate an Employeepost
Deactivate an Employeedelete
Update an Employee's detailsput
Returns an employee's profile detailsget
Employer Info
Updates an employer for a customerput
Create a customer's employer informationpost
Get a customer's employer informationget
Fleets
Returns all the program types and the fleets associated with themget
Creates a new Vehicle associated with a Fleetpost
Creates Custom Fields associated with a Fleetpost
Creates a new Contract associated with a Fleetpost
Disables fleet as bookabledelete
Set a fleet as bookablepost
Get Fleet bookable attributeget
Get availability from a static time by day for every day between start and end, inclusiveget
Get availability from a static time by 30-minute interval for every interval between start and end, inclusiveget
Get availability by day for every day between start and end, inclusiveget
Get availability by 30-minute interval for every interval between start and end, inclusiveget
Get active fleet size and required vehicles needed within a time rangeget
Deletes a fleet. NOTE: Temporarily Disabled. See SC-5730.delete
Updates a fleetput
Gets a fleetget
Returns quantity of cars offending defleet limitsget
Returns a given dealerships vehicle trims for all her fleetsget
Fleet Settings
Gets a key value pair of program typesget
Updates a fleet settings instanceput
Gets a fleet settings instanceget
/admin/dealerships/{dealership_id}/fleet_settings/bulk_updatepost
Geolocation
Returns the contexts against vins that includes location, offlot radius and contract statusget
Returns the distance between 2 addresses and whether the distance falls inside a radial boundpost
Insurance
postAdminCustomerInsurancepost
Create a insurance for a customerpost
updateAdminCustomerInsuranceput
Update insurance for a customerput
Return the current active insurance the customer hasget
Issues
Resolves an issueput
Deletes an issuedelete
Managed Toggles
Update the printed order of the toggle group's togglesput
Deactivate a ManagedToggle for a Dealershipdelete
Activate a ManagedToggle for a Dealershippost
Deletes a toggle group's toggledelete
Updates a toggle group's toggleput
Oem Infos
Deletes Oem Infodelete
Update Oem Infoput
Creates a new Oem Infopost
Retrieve Oem Info given Oem and Oem Dealer Codeget
Payment Provider Configuration
Returns the token and provider name available for the authenticated userget
Recalls
Triggers the import of a recall filepost
Retrieve a specific recall by VIN and Recall IDget
Retrieve recalls for a specific VINget
Roles
Returns the grantable roles for a given dealershipget
SCBA Booking Flow
Gets Dealership Fleet Pricingget
Gets Dealership Availabilityget
Returns Dealerships with Address where Bookable field is Trueget
ScheduleNote
Create or Update a note attached to a reservation in our Schedule componentpost
Settings
/admin/dealerships/{id}/fleet_settingsget
Telematics
Deletes the vehicle telematics settingsdelete
Sets the vehicle telematics settings for all non-embedded providers (i.e. CCDs)put
Returns the vehicle telematics settingsget
Updates a dealership's telematics settings - Available to customer support users only.put
Returns the dealership telematics settingsget
Enroll all Vehicles in a non-disposed state for location.post
Tenancy
Add one or more locations to tenancy grouppost
Remove group location from groupdelete
Creates a new tenant grouppost
Returns a list of all tenant groupsget
Returns the available location ids as a string for a given tenant groupget
Deletes tenancy records created during to automation testingdelete
Toggle Groups
Creates a new toggle group (a group that manages toggles for all dealerships associated with it) - Available to customer support users only.post
Gets toggle groups, excluding discarded ones.get
Deletes a toggle groupdelete
Updates a toggle groupput
Returns the requested toggle group objectget
Creates a new toggle for a toggle group - Available to customer support users only.post
Returns the list of toggles from a toggle groupget
Get all the agreements for a location with their associated togglesget
Disables managed toggles for a dealership - Available to customer support users only.delete
Updates a dealership's toggle group - Available to customer support users only.put
Enables managed toggles for a dealership - Available to customer support users only.post
Toll Providers
Creates a new Toll Providerpost
Lists existing Toll Providersget
Deletes a toll providerdelete
Updates a toll providerput
Returns the requested toll provider objectget
User
Update the currently logged in user's dw-web preferencesput
Update the currently logged in user's passwordput
Update the currently logged in user's detailsput
Get the currently logged in userget
Users
Reset a users password with valid reset password tokenput
/admin/users/password/forgotpost
Create a user's password, confirm their accountpost
Vehicles
Retrieve Vehicle Telematics Detailsget
Fetch the last recorded telemetry for a given vehicleget
Enrollment status of vehicleget
Get all service warnings for a given vehicleget
Create new issue for the vehiclepost
Get all issues for a given vehicle (paginated)get
Updates a Vehicle's Fleetput
Get all telematics events for a given vehicleget
Unenroll Vehicledelete
Enroll Vehiclepost
Get all collision events for a given vehicleget
Updates a Vehicle's Fleetsput
Returns a singular Vehicle objectget
Parking Lot
Parking Lot Ingestionpost
Create a insurance for a customerpost
Update insurance for a customerput

MOB-API
Admin
View Rental Agreement detailsget
Regenerate Rental Agreementput
Admin login endpointpost
Returns the Status for all vehicles at a given dealership on the Dashboard tablesget
/admin/contracts/{id}/rental_agreementsget
Generates a Contract's Rental Agreementpost
Creates a contactless text message associated with a contractpost
Agreement Toggles
Update the printed order of the fleet's Agreement Togglesput
Create a new Agreement Toggle for a given fleetpost
Return the Agreement Toggles scoped to the given fleet idget
Delete an Agreement Toggledelete
Update an Agreement Toggleput
Agreements
Retrieve a preview of the custom-mapped agreement that will be used for the dealership.get
Performs cleanup work to transition dealership to using a provider agreement. Should be called after uploading new agreement with Salesforce.post
Update mappings for an agreementput
Get existing mappings for an agreementget
Get all fields that can be mapped onto an agreementget
Availability
Load dealership information to the Availability Service (AVL)post
Availability 2.0
Get availability for a Fleet/Program with intervalsget
Get availability for a Fleet/Programget
Billing
Creates effective Pricing Setting associated with a fleetpost
Returns the historical Pricing Settings objects associated with a fleetget
Contactless
Create a Signature Image for the Driverpost
Returns Contactless Contract/Driver Informationget
Contracts
Manually start the given contract with superuser privileges, overriding the start dateput
Modify the given contract with superuser privilegespatch
Returns contactless contract dataget
Creates a new signature associated with a contactless contractpost
Fetch the fleets for a location, along with the contracts (within the given time range, all statuses) and vehicles for eachget
Fetch the manifest scope of contracts for a dealership with a pickup/dropoff time of the current dayget
Query the manifest scope (open and closed today) of contracts for a dealershipget
Fetch the manifest scope (open or closed today) of contracts for a dealershipget
Fetch the Payment Methods belonging to the given Customerget
Fetch the contracts for a customer at a particular dealershipget
Removes the Warranty from a Contractdelete
Update the Contract's Warrantyput
Creates a Warranty for a Contractpost
Returns a Warranty for a Contractget
Returns a list of available vehicles for a contract based on the provided queryget
Retrieves a list of available vehicles for the given contractget
Unassign the vehicle currently assigned to the given contractput
Assign a Vehicle to the Given Contractput
Finish the given Contractput
Start the Given Contractput
Cancel the Given Contractdelete
creates a additional payer pdf reciept.post
Fetch the available vehicle groups for a split billget
Generate split bill PDF for the given contractpost
Deletes the payment of the split bill of a given contractdelete
Creates a payment for the split bill of a given contractpost
Creates an adjustment of the specified amount on a contract's split billpost
Fetch the adjustment associated to a given contract's split billget
Deletes a split billdelete
Update the split bill associated with a given contractput
Creates a split bill that is associated with a given contractpost
Fetch the split bill associated to a given Contractget
Create a settlement attempt on the balance of the contractpost
Generate and fetch receipt PDF for the given contractpost
Fetch the pricing information of a given Contractget
Fetch the payments attached to a given Contractget
Update the payment method for the given contractput
Delete a note for a contractdelete
Update a note for a contractput
Add a note for a contractpost
Get the notes for a contractget
Fetch Details for needed information to begin a given contractget
Fetch the customer attached to a given Contractget
Create a billing adjustment (charge or credit) for the given contractpost
Fetch the available adjustments for a given contractget
Create a Driver attached to a given Contractpost
Get all Drivers attached to a given Contractget
Fetch the authorization amount for a given contractget
Get all Toggles attached to a given Contractget
Update Details for a Given Contractput
Fetch Details for a Given Contractget
Customers
Returns the Customer objects available to the authenticated user, whose names also match the query stringget
Finds a single Customer profile based on the given token and driver's license/email infopost
Sends an SMS to a new/existing Customer to create/update their Customer profilepost
Get cached profile information for a customerget
Returns the list of Customers associated with a dealership based on search queryget
Create a new customer associated with a dealershippost
Returns the list of Customers associated with a dealershipget
Deletes the list of Customers associated with the id's passed in body of request.delete
Creates the third party insurance verified account information for future lookuppost
Returns the third party verified insurance for a Customerget
Update a Customer's profileput
Returns a customers's profile detailsget
Dealerships
Agreement Group Deletedelete
Insurance Forms Listget
Gets the most recent rental agreementget
Add a new rental agreement to a locationpost
Agreement Group Updateput
Agreement Group Createpost
Agreement Group Listget
Returns a paginated list of Parking Lot objectsget
Returns a dealership IDget
Update a dealershipput
Gets Toggles per Dealership Agreementget
Disable dealership insurance verification enrollmentput
Enroll dealership in verified insurance integrationpost
Get list of dealerships enrolled in insurance verification integrationget
Gets Fleets Availability and Ratesget
Update the customer information for a reservationput
Get the customer information for a reservationget
Update a Reservation within a single endpointput
Create a Reservation within a single endpointpost
Create a new dealershippost
Returns the user roles for a given locationget
Returns the Dealership objects available to the authenticated user, whose names also match the query stringget
Gets all vehicles no matter the state for a dealerget
Returns the list of Vehicle objects associated with a dealership based on search queryget
Creates a new Vehicle for a Dealership and assigns it to a list of Fleetspost
Returns a paginated list of Vehicle objects associated with a dealershipget
Updates the dealership's settings - Available to customer support users only.put
Returns the dealership settingsget
Returns the list of Service Advisors associated with a dealershipget
Get Filtered and/or Sorted Dealership Report Transactions Datapost
Get Dealership Report Transactions Dataget
Get Dealership Report Summaryget
Get Dealership Report Revenue Dataget
Get Dealership Receivables Report Summaryget
Get Dealership Receivables Report Dataget
Get Dealership Report Vehicle Inventory Dataget
Returns the dealership specific or default set of KPIspost
Check the status of bulk onboarding vehicles by CSV, and return a big chunk of json response of the statusget
Bulk onboarding vehicles by uploading a CSV file, and return a list of results about success/errorpost
Creates a new fleet associated with a dealershippost
Returns the list of Fleet objects associated with a dealershipget
Returns a paginated list of Vehicle objects for the Calendarget
Returns a paginated list of Reservations or Contracts for a Dealership Calendarget
Sets Dealership bookable attribute to false – authorized users are controlled by a feature flagdelete
Set Dealership bookable attribute to true – authorized users are controlled by a feature flagpost
Get Dealership bookable attributeget
Get availability from a static start time for all cars in a dealership by day for every day between start and end, inclusiveget
Get availability from a static start time for all cars in a dealership by 30-minute interval for every interval between start and end, inclusiveget
Get availability for all cars in a dealership by day for every day between start and end, inclusiveget
Get availability for all cars in a dealership by 30-minute interval for every interval between start and end, inclusiveget
Returns the list of Agreements objects associated with a dealershipget
Updates the dealership addressput
Returns the dealership addressget
Updates the Dealership and/or its Fleets' Settingspatch
Returns the requested dealership object to the authenticated userget
Returns the Dealership objects available to the authenticated userget
Open Days
Updates Dealership Open Days and Business Hoursput
Drivers
Create a Signature Image for the Driverpost
Delete a Driverdelete
Update a Driver's detailsput
Get a Driver's detailsget
Employees
Returns the list of Employees associated with a dealership based on search queryget
Create a new employee associated with a dealershippost
Returns the list of Employees associated with a dealershipget
Update an employee's roles for a dealershipput
Returns an employee's roles for a dealershipget
Activate an Employeepost
Deactivate an Employeedelete
Update an Employee's detailsput
Returns an employee's profile detailsget
Employer Info
Updates an employer for a customerput
Create a customer's employer informationpost
Get a customer's employer informationget
Fleets
Returns all the program types and the fleets associated with themget
Creates a new Vehicle associated with a Fleetpost
Creates Custom Fields associated with a Fleetpost
Creates a new Contract associated with a Fleetpost
Disables fleet as bookabledelete
Set a fleet as bookablepost
Get Fleet bookable attributeget
Get availability from a static time by day for every day between start and end, inclusiveget
Get availability from a static time by 30-minute interval for every interval between start and end, inclusiveget
Get availability by day for every day between start and end, inclusiveget
Get availability by 30-minute interval for every interval between start and end, inclusiveget
Get active fleet size and required vehicles needed within a time rangeget
Deletes a fleet. NOTE: Temporarily Disabled. See SC-5730.delete
Updates a fleetput
Gets a fleetget
Returns quantity of cars offending defleet limitsget
Returns a given dealerships vehicle trims for all her fleetsget
Fleet Settings
Gets a key value pair of program typesget
Updates a fleet settings instanceput
Gets a fleet settings instanceget
/admin/dealerships/{dealership_id}/fleet_settings/bulk_updatepost
Geolocation
Returns the contexts against vins that includes location, offlot radius and contract statusget
Returns the distance between 2 addresses and whether the distance falls inside a radial boundpost
Insurance
postAdminCustomerInsurancepost
Create a insurance for a customerpost
updateAdminCustomerInsuranceput
Update insurance for a customerput
Return the current active insurance the customer hasget
Issues
Resolves an issueput
Deletes an issuedelete
Managed Toggles
Update the printed order of the toggle group's togglesput
Deactivate a ManagedToggle for a Dealershipdelete
Activate a ManagedToggle for a Dealershippost
Deletes a toggle group's toggledelete
Updates a toggle group's toggleput
Oem Infos
Deletes Oem Infodelete
Update Oem Infoput
Creates a new Oem Infopost
Retrieve Oem Info given Oem and Oem Dealer Codeget
Payment Provider Configuration
Returns the token and provider name available for the authenticated userget
Recalls
Triggers the import of a recall filepost
Retrieve a specific recall by VIN and Recall IDget
Retrieve recalls for a specific VINget
Roles
Returns the grantable roles for a given dealershipget
SCBA Booking Flow
Gets Dealership Fleet Pricingget
Gets Dealership Availabilityget
Returns Dealerships with Address where Bookable field is Trueget
ScheduleNote
Create or Update a note attached to a reservation in our Schedule componentpost
Settings
/admin/dealerships/{id}/fleet_settingsget
Telematics
Deletes the vehicle telematics settingsdelete
Sets the vehicle telematics settings for all non-embedded providers (i.e. CCDs)put
Returns the vehicle telematics settingsget
Updates a dealership's telematics settings - Available to customer support users only.put
Returns the dealership telematics settingsget
Enroll all Vehicles in a non-disposed state for location.post
Tenancy
Add one or more locations to tenancy grouppost
Remove group location from groupdelete
Creates a new tenant grouppost
Returns a list of all tenant groupsget
Returns the available location ids as a string for a given tenant groupget
Deletes tenancy records created during to automation testingdelete
Toggle Groups
Creates a new toggle group (a group that manages toggles for all dealerships associated with it) - Available to customer support users only.post
Gets toggle groups, excluding discarded ones.get
Deletes a toggle groupdelete
Updates a toggle groupput
Returns the requested toggle group objectget
Creates a new toggle for a toggle group - Available to customer support users only.post
Returns the list of toggles from a toggle groupget
Get all the agreements for a location with their associated togglesget
Disables managed toggles for a dealership - Available to customer support users only.delete
Updates a dealership's toggle group - Available to customer support users only.put
Enables managed toggles for a dealership - Available to customer support users only.post
Toll Providers
Creates a new Toll Providerpost
Lists existing Toll Providersget
Deletes a toll providerdelete
Updates a toll providerput
Returns the requested toll provider objectget
User
Update the currently logged in user's dw-web preferencesput
Update the currently logged in user's passwordput
Update the currently logged in user's detailsput
Get the currently logged in userget
Users
Reset a users password with valid reset password tokenput
/admin/users/password/forgotpost
Create a user's password, confirm their accountpost
Vehicles
Retrieve Vehicle Telematics Detailsget
Fetch the last recorded telemetry for a given vehicleget
Enrollment status of vehicleget
Get all service warnings for a given vehicleget
Create new issue for the vehiclepost
Get all issues for a given vehicle (paginated)get
Updates a Vehicle's Fleetput
Get all telematics events for a given vehicleget
Unenroll Vehicledelete
Enroll Vehiclepost
Get all collision events for a given vehicleget
Updates a Vehicle's Fleetsput
Returns a singular Vehicle objectget
Parking Lot
Parking Lot Ingestionpost
Create a insurance for a customerpost
Update insurance for a customerput

200Success

401Unauthorized

403Forbidden

404Not found

406Not Acceptable