Returns the list of Fleet objects associated with a dealership

Time Status User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

id

integer

required

The id of the dealership

include_empty

boolean

Filter results to include empty fleets. Defaults to including all fleets, including empty

truefalse

contractable

boolean

Filter all fleets that are allowed to start a contract. Defaults to false.

truefalse

page

integer

Defaults to 1

Page number to fetch

per_page

integer

Defaults to 30

Number of items per page

api-version

integer

required

Target API version

``200 Success

array of objects

object

id

integer

required

name

string

required

agreement_id

integer | null

required

the ID of the agreement to assign to the fleet

created_at

date-time

required

the date and time when the fleet was created

contractable

boolean

required

whether or not this fleet is allowed to start a contract

external_availability_group

boolean | null

required

whether the fleet is an external availability group

repair_order_number_required

boolean

required

whether repair order numbers are required for this fleet

exclude_rate

boolean | null

required

whether the fleet should use rates

pdf_agreement_url

string | null

required

the pdf of the agreement to assign to the fleet

program_type

string | null

required

A string representing the type of program the fleet is in (courtesy, rental, etc)

source_of_business

string | null

enum

required

Source of business classification for the fleet

customer``internal``warranty

reservation_time_cap

integer | null

required

the maximum amount of time a reservation should be active for, in days

reservation_time_cap_warning

integer | null

required

the number of days before a reservation hits the cap that a warning should be sent

allow_charge_later

boolean

required

allow_manual_signature

boolean

required

require_customer_vin

boolean

required

guided_walkaround_enforced

boolean

required

require_insurance_sufficiency

string

enum

required

Specifies when insurance sufficiency checks are required (none, loaner, rental, or loaner_rental)

none``loaner``rental``loaner_rental

sales_lead_enabled

boolean

whether Service to Sales lead generation is enabled for the fleet

sales_lead_offset_hours

integer

how many hours after service intake a sales lead should be created (1-12)

sales_lead_cms_config_email

string | null

email address the Service to Sales lead configuration should notify

misc

object

required

a JSON object for storing miscellaneous data

misc 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}/fleets


xxxxxxxxxx

curl --request GET \

--url 'https://api.dealerware.com/admin/dealerships/id/fleets?page=1&per_page=30' \

--header 'accept: application/json'

xxxxxxxxxx

[
\
  {\
    "id": 123,\
    "name": "Loaner",\
    "agreement_id": 5,\
    "created_at": "2024-01-01T12:00:00Z",\
    "contractable": "true/false",\
    "external_availability_group": false,\
    "repair_order_number_required": false,\
    "exclude_rate": false,\
    "pdf_agreement_url": "https://www.example.com/agreement.pdf",\
    "program_type": "rental",\
    "source_of_business": "customer",\
    "reservation_time_cap": 60,\
    "reservation_time_cap_warning": 5,\
    "allow_charge_later": true,\
    "allow_manual_signature": false,\
    "require_customer_vin": false,\
    "guided_walkaround_enforced": false,\
    "require_insurance_sufficiency": "loaner_rental",\
    "sales_lead_enabled": false,\
    "sales_lead_offset_hours": 3,\
    "sales_lead_cms_config_email": "leads@dealer.com",\
    "misc": {}\
  }\
]

Updated3 months ago