LogoLogo
API StatusSupportPostmanContact Us
๐Ÿ‡ฌ๐Ÿ‡ง UK AutoGrab API Doc
๐Ÿ‡ฌ๐Ÿ‡ง UK AutoGrab API Doc
  • AutoGrab Basics
    • AutoGrab Developer Hub
    • Integration Overview
    • API Test Cases
    • FAQ
  • Authentication
    • API Key
    • OAuth Authentication
  • Vehicle Search
    • Vehicle Searching Basics
    • Plain-text Search
    • VRM Search
    • VIN Search
    • Facet Search
    • Vehicle ID Search
    • Marketplace ID Lookup
  • Sourcing
    • Sourcing Basics
    • Market Overlay
    • Market Statistics
    • Stock Feeds
  • Vehicle Data
    • Vehicle Data Basics
    • Recall Search
    • MOT & Tax Search
    • Vehicle History
    • Factory Build Data
    • Factory Fitted Options
  • Valuation
    • Valuation Basics
    • Valuation Predictions
    • Residual Valuations
    • Max Offer Configuration
    • Gauge API
  • Embeddable Products
    • Embeddable Basics
    • Gauge Widget
    • Valuation Widget
    • Market Overlay Widget
  • Customer Recapture
    • Customer Recapture
    • Webhooks Integration
  • Insurance
    • Pre-Accident Valuation
Powered by GitBook
LogoLogo

Links

  • Terms of Use

2024 ยฉ AutoGrab Pty Ltd. ABN 79 638 468 569

On this page

Was this helpful?

Export as PDF
  1. Vehicle Search

Marketplace ID Lookup

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

PreviousVehicle ID SearchNextSourcing Basics

Last updated 3 months ago

Was this helpful?

Overview

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

Prerequisites to access.

  1. 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

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.

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
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
  }
}
  • Overview
  • GETGet a vehicle by its marketplace
  • Limitations