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.

1. To be approved to access this special use case endpoint, contact your account manager.

2. Be aware of your listing ID and use that for the marketplace_id parameter.

3. Be aware of your marketplace identifier, it is your public domain name, e.g drive.com.au

Get a vehicle by its marketplace

get

Get a vehicle by its marketplace

Authorizations

Query parameters

marketplacestringRequired

marketplace_idstringRequired

regionstring · enumOptional

The region to perform this request in

Possible values:

reference_idstringOptional

An optional reference id which will be stored against usage records if supplied

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

get

HTTPcURLJavaScriptPython

GET /v2/vehicles/marketplace/ HTTP/1.1
Host: api.autograb.com.au
ApiKey: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "vehicle": {
    "id": "text",
    "region": "au",
    "title": "text",
    "year": 1,
    "make": "text",
    "model": "text",
    "badge": "text",
    "series": "text",
    "body_type": "text",
    "body_config": "text",
    "transmission": "text",
    "wheelbase": "text",
    "fuel": "text",
    "engine": "text",
    "drive": "text",
    "num_doors": 1
  }
}

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"
}

In this scenario, we recommend falling back to a test lookup using the title in its most descriptive format. E.g 2024 Nissan X-TRAIL Ti Wagon Ti 2.5L SUV 4WD. Refer to the text searching guide here.