Inventory

Get vehicles

GET /inventory/vehicles

Query string parameters

• Supports Pagination
• Supports Searching
• registration_date_from date
  • Y-m-d format
• registration_date_to date
  • Y-m-d format
• updated_before date
  • Y-m-d format
• updated_after date
  • Y-m-d format
• mileage_from number
• mileage_to number
• price_from integer
• price_to integer
• fuel_type string
  • One of the following:
    • petrol
    • diesel
    • LPG
    • natrual_gas
    • electric
    • hybrid_petrol
    • hydrogen
    • ethanol
    • hybrid_diesel
    • other
• transmission string
  • One of the following:
    • manual
    • semi_automatic
    • automatic
    • other
• power_from number
• power_to number
• exterior_color string
  • Comma separated list of values
• drivetrain string
  • Comma separated list of values
  • One of
    • awd
    • fwd
    • rwd
• ids string
  • Comma separated list of values
• make string
  • Comma separated list of values
• status string
  • One of the following:
    • available
    • unavailable
    • sold
• assigned_to string
  • One of the following:
    • case
    • offer
• external_id string

Response
Status code 200

{
    "data": [
        {
            "id": "a1d8dd90-93d8-4d08-9c3b-b162af139af7",
            "make": "bmw",
            "model": "116d ED",
            "vin": "JKBVNKD167A013982",
            "external_id": "123456qwerty",
            "price": {
                "gross": 123456,
                "net": 123456789,
                "vat": 20
            },
            "leasing_price": {
                "gross": 1234,
                "net": 1234789,
                "vat": 20
            },
            "registration_date": "1980-01-01 12:12:12",
            "mileage": {
                "kilometers": 123
            },
            "model_year": 1980,
            "fuel_type": "petrol",
            "ccm": 123456,
            "power": {
                "hp": 123,
                "kw": 123
            },
            "transmission": "automatic",
            "drivetrain": "awd",
            "body_type": null,
            "number_of_doors": 3,
            "image": "https://i.picsum.photos/id/1080/200/300.jpg",
            "images": ["https://i.picsum.photos/id/1080/200/300.jpg"],
            "color": {
                "interior": "white",
                "exterior": "brown"
            },
            "fuel_efficiency": {
                "kilometers_per_liter": {
                    "city": null,
                    "highway": null,
                    "combined": null
                },
                "litres_per_100_kilometres": {
                    "city": null,
                    "highway": null,
                    "combined": null
                }
            },
            "wltp": {
                "emission": null,
                "consumption": null
            },
            "efficiency_class": null,
            "euro_emission_class": null,
            "environment_class": null,
            "description": null,
            "number_of_gears": 8,
            "number_of_seats": 7,
            "car_status": "new",
            "number_of_previous_owners": null,
            "warranty": false,
            "country_version": null,
            "price_changes": [
                {
                    "created_at": "2020-01-01 12:12:12",
                    "from": 1,
                    "to": 1000,
                    "type": "price"
                }
            ],
            "assigned_to_offer": false,
            "cases": [
                {
                    "id": "9487215b-f9ed-468e-b169-9d36b1b1ac3d",
                    "number": 123,
                    "offer": false
                }
            ],
            "status": "available",
            "created_at": "2020-01-01 12:12:12",
            "updated_at": "2020-01-01 12:12:12"
        }
    ],
    "pagination": {
        "total": 1,
        "page": 1,
        "per_page": 15,
        "urls": {
            "previous": null,
            "next": null
        }
    }
}

Get vehicle

GET /inventory/vehicles/:id

Response
Status code 200

{
    "id": "a1d8dd90-93d8-4d08-9c3b-b162af139af7",
    "make": "bmw",
    "model": "116d ED",
    "vin": "JKBVNKD167A013982",
    "external_id": "123456qwerty",
    "price": {
        "gross": 123456,
        "net": 123456789,
        "vat": 20
    },
    "leasing_price": {
        "gross": 1234,
        "net": 1234789,
        "vat": 20
    },
    "registration_date": "1980-01-01 12:12:12",
    "mileage": {
        "kilometers": 123
    },
    "model_year": 1980,
    "fuel_type": "petrol",
    "ccm": 123456,
    "power": {
        "hp": 123,
        "kw": 123
    },
    "transmission": "automatic",
    "drivetrain": "awd",
    "body_type": null,
    "number_of_doors": 3,
    "image": "https://i.picsum.photos/id/1080/200/300.jpg",
    "images": ["https://i.picsum.photos/id/1080/200/300.jpg"],
    "color": {
        "interior": "white",
        "exterior": "brown"
    },
    "fuel_efficiency": {
        "kilometers_per_liter": {
            "city": null,
            "highway": null,
            "combined": null
        },
        "litres_per_100_kilometres": {
            "city": null,
            "highway": null,
            "combined": null
        }
    },
    "wltp": {
        "emission": null,
        "consumption": null
    },
    "efficiency_class": null,
    "euro_emission_class": null,
    "environment_class": null,
    "description": null,
    "number_of_gears": 8,
    "number_of_seats": 7,
    "car_status": "new",
    "number_of_previous_owners": null,
    "warranty": false,
    "country_version": null,
    "price_changes": [
        {
            "created_at": "2020-01-01 12:12:12",
            "from": 1,
            "to": 1000,
            "type": "price"
        }
    ],
    "assigned_to_offer": false,
    "cases": [
        {
            "id": "9487215b-f9ed-468e-b169-9d36b1b1ac3d",
            "number": 123,
            "offer": false
        }
    ],
    "status": "available",
    "attributes": {
        "comfort": [],
        "entertainment": [],
        "sight": [],
        "safety": [],
        "assistant_systems": [],
        "others": [],
        "sport": [],
        "extra": []
    },
    "created_at": "2020-01-01 12:12:12",
    "updated_at": "2020-01-01 12:12:12"
}

Get vehicle alternatives

GET /inventory/vehicles/:id/alternatives

Path parameters

• id UUID
  • Required
• Supports Pagination

Response
Status code 200

{
  "ids": [
    "8a6a7125-310e-47e8-b0e2-0a99852a0cdf",
    "cf389115-7d71-42f5-9f2c-6ea2a9f338b1",
    "142855a3-4431-4caf-b86b-7d0cb1145da1",
    "eb366129-2eba-4732-abc0-df7b6b12eaf2"
    ]
}

Create import

POST /inventory/import

Parameters

• provider string
  • Required
  • Minimum 1 character
  • Maximum 190 characters
• company_id integer
  • Required
• team_id integer
• number_of_vehicles integer
  • Required
  • Minimum value: 1

Payload

{
  "provider" : "CarDealer",
  "company_id" : 10,
  "team_id" : 342,
  "number_of_vehicles" : 12
}

Response
Status code 200

{
  "id": "9487215b-f9ed-468e-b169-9d36b1b1ac3d"
}