Marketplace ID Lookup

A special use case endpoint for our marketplace customers to find their own leads on AutoGrab systems.

PreviousFacet Integration Worked Example NextVehicle ID Search

Was this helpful?

Marketplace ID Lookup

A special use case endpoint for our marketplace customers to find their own leads on AutoGrab systems.

Overview

In a scenario where you want to understand the vehicle ID or data on listed vehicles, you can use the marketplace search system.

Prerequisites to access:

To be approved to access this special use case endpoint, contact your account manager.
Be aware of your listing ID and use that for the marketplace_id parameter.
Be aware of your marketplace identifier, it is your public domain name, e.g drive.com.au

Example Usage

For example, if you were AutoTrader located in NZ with listing 808159 you could form the request below.

/v2/vehicles/marketplace/?marketplace=autotrader.co.nz&marketplace_id=808159&region=nz

You will get this response with the vehicle ID "4969003601429068" allowing you to interact with other services like the , and more.

{
  "success": true,
  "vehicle": {
    "id": "4969003601429068",
    "region": "au",
    "title": "2023 GWM Haval H6GT Ultra Auto 4WD",
    "year": "2023",
    "make": "GWM",
    "model": "Haval H6GT",
    "badge": "Ultra",
    "series": "B03",
    "model_year": null,
    "release_month": 8,
    "release_year": 2022,
    "body_type": "SUV",
    "body_config": null,
    "transmission": "Dual Clutch Automatic (DCT)",
    "transmission_type": "Automatic",
    "wheelbase": null,
    "wheelbase_type": null,
    "fuel": "Petrol",
    "fuel_type": "Petrol",
    "engine": "Piston",
    "engine_type": "Piston",
    "drive": "AWD",
    "drive_type": "Four Wheel Drive",
    "num_doors": 5,
    "num_seats": 5,
    "num_gears": 7,
    "num_cylinders": 4,
    "capacity_cc": 1998,
    "power_kw": 150,
    "torque_nm": 320,
    "range": 714,
    "options": [
      {
        "detail": "Metallic Paint",
        "price": 495
      },
      {
        "detail": "Standard Paint",
        "price": 0
      }
    ]
  }
}

Limitations

You are only able to search for a vehicle once it is present on our service. If you receive the error below this means we are not yet aware of the listing due to its recency.

{
  "error": true,
  "message": "Vehicle via marketplace drive.com.au/969515013 not found in database"
}