availability 20

URL Expired

The URL for this request expired after 30 days.

Parameters

• group_id
  integer
  required
  The id of the Fleet/Program

• start_at
  date-time
  required
  The timestamp for the start of the availability range

• end_at
  date-time
  required
  The timestamp for the end of the availability range

• include_estimates
  boolean
  Defaults to false
  Whether to include billing estimates for each make and model. Does not work with time_slot_interval.

• ignore_reservation_ids
  string
  Comma-separated list of reservation IDs to ignore when calculating availability. Useful for modifying existing reservations.

• api-version
  integer
  required
  Target API version

Responses

Successful Response

• 200 Success
  array of objects
  • object
    • id
      integer
      Origin group id
    • name
      string
      Group name generated from model description, or existing group name
    • available_vehicle_count
      number
      Number of available vehicles in the group
    • total_vehicle_count
      number
      Number of total vehicles in the group
    • make
      string
      Vehicle make for the group
    • model
      string
      Vehicle model for the group
    • trim
      string
      Vehicle trim for the group
    • body_type
      string
      Vehicle body type for the group
    • power_train
      string
      Vehicle power train for the group
    • available_vehicles
      array of objects
      • available_vehicles
        object
        • id
          integer
          Origin vehicle id
        • vin
          string
          Vehicle VIN
        • base_msrp
          string
          Base MSRP
        • estimate
          object

Error Responses

• 400 Bad Request
• 403 Forbidden
• 404 Not found

Example Request

curl --request GET \
     --url 'https://api.dealerware.com/admin/availability/groups/group_id?include_estimates=false' \
     --header 'accept: application/json'

Example Response

[
  {
    "id": 42,
    "name": "2 Door Coupe/Convertible Roadster",
    "available_vehicle_count": 1,
    "total_vehicle_count": 2,
    "make": "GMC",
    "model": "Sierra 1500",
    "trim": "Elevation",
    "body_type": "Crew Cab",
    "power_train": "mechanical",
    "available_vehicles": [
      {
        "id": 42,
        "vin": "1G1YY22G8X5123456",
        "base_msrp": "$28,760.00"
      }
    ],
    "estimate": {
      "program_id": 1,
      "transaction_days": 3,
      "currency_code": "USD",
      "taxes": [
        {
          "type": "sales tax",
          "total": 6
        }
      ],
      "rates": [
        {
          "type": "rental",
          "total": 60,
          "description": "2 Days at $30.00 per day"
        }
      ],
      "fees": [
        {
          "type": "facility",
          "total": 15
        }
      ],
      "tax_total": 6,
      "rates_total": 60,
      "fees_total": 15,
      "tax_average_per_day": 2,
      "rates_average_per_day": 20,
      "fees_average_per_day": 5
    }
  }
]

Updated 3 months ago