1 of 51

🇳🇿 NZ AutoGrab API Doc

AutoGrab Basics

AutoGrab Developer Hub

Welcome to the developer hub, this is your reference to integrate with all aspects of the system. We've got guides and reference materials to support and accelerate your development.

You can explore our endpoints by searching or asking questions through the AI-powered doc system. See what product fits your user case by clicking a top-level grouping below.

Integration Overview

Key things to know before you start.

Overview

Our API uses the OpenAPI 2.0 specification, making it easy for our partners to integrate. We want to ensure the best possible experience when integrating with our stack.

API Test Cases

Test your requests in a safe zero-cost way through our test case set.

You can use our test cases to confirm your implementation on our production endpoints. All requests using these values are not billable.

Test Cases

Refer below to set of test cases. They are all linked and refer back to the same vehicle IDs.

Type

Region

Value

Outcome

Supported Endpoints

Test cases are supported across a range of API endpoints listed below. If the endpoint you are testing with is not listed get in touch to request test data.

/valuations/predict
/valuations/vins
/valuations/registrations

Implementation Guide

An example implementation could run a test as part of an integration test or development process. For example, you could test a valuation flow by first using a registration plate to get the ID (which is also test data) and send that to a /predict to get a valuation and a market overlay.

Authentication

Basic Key Based Authentication

We support API key-based authentication, recommended if you build applications to integrate with our platform.

Do you need a key? Contact your sales rep or contact to request one to start developing.

Key Types

Secret API Key

A secret API key is for the server side and should not be shared with the front end.

Example Key: sec_23hcfb8374bfhc833i4uhx

Public API Key

A public API key is used on your website to call the API. These keys are limited to your domain and are safe to share publicly.

Example Key: pub_3ficuhb34u8fnxu34h9fm

Authenticating Requests

When making requests to the APIs, include the key in your request.

Other Authentication Methods

We also support , you can read more about this authentication mechanism here.

OAuth Authentication

At the customer's preference, it is possible to integrate with our APIs via OAuth client credential token grant.

OAuth integration consists of 2 basic components:

Token management (ensure your system always has a valid OAuth token available)
REST API call signing using a valid token

Token management

Before implementing token management, make sure you have a valid client_id and client_secret as provided by us (Your sales rep will provide them). These are the credentials you will use to get valid tokens from the auth-broker.

auth-broker POST call to receive a valid OAuth token

A valid token can be stored locally for use in subsequent API calls. It is recommended to calculate a safe expiry timestamp based on the expires_in property of the response body and use this to pre-emptively refresh your token when it nears expiry.

REST API call signing

With a valid OAuth token, each REST API call that you make can be authorised by encoding the as-provided token string into your Authorization header using the Bearer prefix.

Troubleshooting

Token management

I don’t get a 200 response on my request-token calls Double-check your client_id and client_secret with AutoGrab. Double-check your Basic Auth encoding. Double-check your content-type header and post-body structure.
I have a valid token but my API calls are failing 401 response -- there may be a problem with your token, or the way Bearer Auth is being encoded in the headers.

Vehicle Search

Vehicle Searching Basics

Vehicle discovery is the starting place for almost all functions on the AutoGrab API.

The Vehicle Search API set allows you to find matching vehicles within our database. This API requires authentication and an appropriate license attached to it.

Plain-text Search

Get results with a text string search

The Vehicle Search API allows you to search for matching vehicles by plain-text input. The API will return an array of vehicles and the confidence score in a match for that given vehicle.

The request requires a region, search string & API key. The default page length is 10, however, you can adjust this based on your requirements.

Example

Example Payload

VIN Search

Get vehicle details from a VIN.

The Vehicle VIN API allows you to search for vehicles by VIN. The request requires only a region, VIN & API key. This will return either a matching vehicle with possible option packs, or a null.

Example

Example Response

Remember you can enrich your VIN payloads with features, .

Facet Search

Use smart drop downs to find a vehicle.

Search for Vehicles by facets

The Vehicle Facets API allows you to narrow down the matching vehicle based on the vehicle's parameters. The facets available are: year, make, model, badge, series, transmission, body, body_style, fuel, engine and wheelbase.

If you would like to return aggregations of factes, use a comma-separated list in the facets field: eg. facets=badge,series,transmission.

Facets User Interface Example

This function is useful when supplying data to drop-downs for display on a form. A good example of using Facets API is .

For a preview of how facets in implemented inside the AutoGrab web app see the video below.

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:

Vehicle ID Search

Get summary data on a vehicle by searching for its ID

If you know a vehicles ID already and would like summary data you can leverage a basic vehicle search.

Request

v2/vehicles/5233518187642880?region=nz

Response

{
    "vehicle": {
        "id": "5233518187642880",
        "region": "nz",
        "title": "2010 Volkswagen Polo Comfortline Automatic",
        "year": "2010",
        "make": "Volkswagen",
        "model": "Polo",
        "badge": "Comfortline",
        "series": "6R",
        "model_year": "MY10",
        "release_month": 1,
        "release_year": 2010,
        "body_type": "Hatchback",
        "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": "FWD",
        "drive_type": "Front Wheel Drive",
        "num_doors": 5,
        "num_seats": 5,
        "num_gears": 7,
        "num_cylinders": 4,
        "capacity_cc": 1390,
        "power_kw": 63,
        "torque_nm": 132,
        "range": null,
        "options": []
    },
    "success": true
}

Matching Confidence

Understand how we match vehicles and the expected outcomes.

The matcher is a foundational piece of technology that reconciles market, listing and data inputs describing cars against our vehicle catalogue. This is done so you can utilise our market-leading vehicle ID for additional workflows like valuation, market data and more.

For example, when you request information on a registration plate the primary input we receive is its description "upstream_vehicle": "2019 Isuzu Ute MU-X 4x2 LS-M 4 Wagon 6sp auto 3.0L 3000cc 4cyl T/Diesel 2018. That needs to be matched to "id": "4843865643155456" which represents hundreds of data points related to the Isuzu.

We are transparent about the confidence of the match and you can leverage this to inform your workflows. In each relevant vehicle discovery method you will receive a "confidence" response.

Confidence Parameter

Explanation

In the reduced confidence outcome we highly recommend showing the upstream_vehicle parameter. This will help your user ensure the vehicle we have responded with is representative of the real vehicle.

Sourcing

Sourcing Basics

Find the right market data to inform your decision making

The Sourcing API set allows you to find listing data for comparative and market insights. This API requires authentication and an appropriate license attached to it.

Features

Enrich your market overlay payloads with additional data.

The market overlay can be enhanced by passing option feature parameters. You can request a single feature or combine them to enrich your responses. You must have a unique permission enabled by your sales representative for each feature.

Dealer Contact Details

This feature will deliver the contact details of the advertising dealership as per the listing. Use features=dealer_contact_details

Market Statistics

Get key statistics on any vehicle ID

Overview

The Market Overlay Statistics API delivers statistics we generate on your behalf from the Market Overlay endpoint.

Starting with your Vehicle ID post it to the statistics endpoint.

v2/sourcing/market_overlay/statistics/5655899674771456&minimum_days=60&region=nz

An example response is below.

{
    "success": true,
    "sample_size": 282,
    "days_checked": 60,
    "outlier_count": 9,
    "avg_days_to_sell": 14.310300431547615,
    "price_when_new": 56390
}

As this endpoint is part of the market overlay route you can enhance your payload with additional features. Refer to to see what's available.

Vehicle Data

Vehicle Data Basics

Get the level of detail you need on the vehicle you want.

The Vehicle Data API set allows you to find descriptive information on a vehicle at the level of granularity you require. This API requires and an appropriate license attached to it.

Valuation

Valuation Basics

The Valuation API set allows you to predict current and future prices on vehicles. This API requires and an appropriate license attached to it.

Valuation Predictions

Generate market accurate predictions for vehicles.

Overview

The Valuation API can be used to determine the present retail & trade values, as well as the residual values of new vehicles.

This API requires and an appropriate license attached to it.

To use the API, a Vehicle ID returned from the Vehicle Search API or Vehicle Facet API is required.

Adjustments

Adjust valuations we send you based on a rule set.

Both the Residual Value and Used Value APIs support pricing adjustments. These can be used to retrieve a more accurate price prediction of a vehicle if the provided price is not already accurate enough.

Recommended Retail Price Adjustment

To adjust the stored Recommended Retail Price you can supply a rrp_adjustment value in the payload which accepts a number — positive or negative.

Condition Array

Predict all potential values across many conditions for a vehicle.

If you wish to predict valuations at all available conditions of the vehicle. That is those between 1 and 5,with 1 being poor and 5 being excellent condition. You can utilise the conditions in the same way you would use the standard /v2/valuations/predict/ endpoint.

In this endpoint, we will return all available conditions in an array. This can power great user experiences where you may wish to show a large range depending on the condition of the vehicle.

{
    "success": true,
    "prediction": {
        "id": "8b8663c6-fa04-4a77-9f31-fd2fc32cefa9",
        "vehicle_id": "4648873456828416",
        "kms": 30000,
        "price": 15986,
        "score": 0.6676,
        "retail_price": 15986,
        "adjustment": null,
        "conditions": [
            {
                "condition_score": 1,
                "trade_price": 8740.2
            },
            {
                "condition_score": 2,
                "trade_price": 9988.8
            },
            {
                "condition_score": 3,
                "trade_price": 11237.4
            },
            {
                "condition_score": 4,
                "trade_price": 11861.7
            },
            {
                "condition_score": 5,
                "trade_price": 12486
            }
        ]
    }
}

Valuation Features

Generate upper and lower bounds on each valuation.

Valuation Bounds

If you require the upper and lower bounds used to calculate a prediction you can use features=bounds.

This will yield the bounds on the retail and trade prices.

/v2/valuations/registrations/BMT038?features=bounds

Residual Valuations

Predict the future value of a vehicle.

The Residual Value prediction API uses current market trends to influence the depreciation curve of newer vehicles. The API allows you to influence the outcome of the prediction by either mutating stored Recommended Retail Price or by providing your own Retail Value for the car.

In the example below we are sending the vehicle ID along with other key details to /v2/valuations/residual. The example body of the post is below.

This yields a prediction over the 5-year projection timeframe as below.

Registration & VIN Valuations

Generate a valuation with a Registration Plate or VIN

Registration Valuation

POST the registration plate and region to /v2/valuations/registrations/BMT038?

Example Response

Valuation Features

Enhance your requests with additional data.

You can request more data than the standard payload by leveraging a range of features described below.

Ensure your commercial agreement has these features enabled if you require them.

Max Offer - Retail Base

This feature will return your max configuration in your valuation with the final price showing the deductions from the retail valuation. Use features=max_offer to receive this payload. Read more on how to set and update your .

Max Offer - Trade Base

This feature will return your max configuration in your valuation with the final price showing the deductions from the trade valuation. Use both features=max_offer_trade,max_offer to receive this payload. Read more on how to set and update your .

Bounds

This feature will return the upper and lower bounds used as part of your valuation. Use features=bounds to receive this payload.

Max Offer Configuration

Set and update your max offer config to refine your price predictions.

Get Configuration

Get your existing max offer configuration by using the request below.

/v2/valuations/max_offer_configuration

You will receive a payload as per below showing you your current configuration.

{
  "success": true,
  "max_offer_configuration": {
    "reconditioning_percentage": 0,
    "reconditioning_fixed": 0,
    "profit_margin_percentage": 0,
    "profit_margin_fixed": 0,
    "lot_percentage": 0,
    "lot_fixed": 0,
    "transport_percentage": 0,
    "transport_fixed": 0,
    "admin_percentage": 0,
    "admin_fixed": 0
  }
}

Update Configuration

Upsert a max offer configuration to change a part of it.

/v2/valuations/max_offer_configuration

Your PUT request must conform to our schema as outlined below.

AutoGauge

Create your own price indication and benchmarking gauge.

The AutoGrab AutoGauge is an endpoint that delivers market benchmarking information with inputs of listing information. It supports a range of inputs depending on your use case.

Example Post Body

The body of the request can accept a range of inputs depending on your listing data. All available inputs are below.

The response for this request is below. The AutoGauge can be presented with a broad range of vehicle identifiers and will consider them dependent on your commercial agreement. In the scenario above, the AutoGrab ID was presented and used, and all other inputs were supplied as backups.

Embeddable Products

Embeddable Basics

AutoGrab hosts a range of embeddable products you can use to rapidly deploy solutions to the market to engage new customers and delight existing ones.

Valuation Widget

The Valuation Widget offers an easy-to-configure and install instant cash offer journey for your website.

Overview

The widget can capture leads by auto-filling vehicle information, asking key questions and making a conditional offer informed by your preset valuation strategy.

It is highly customisable to your dealership brand or corporate imagery requirements, feeling at home on your existing website.

The resulting leads are deployed over email or select LMS providers depending on your region.

Other Products & Resources

Pre-Accident Valuation API Suite

Deliver you own PAV style product by leveraging a range of AutoGrab API products.

To deliver a PAV-style experience you can leverage existing API endpoints to deliver your desired UX. Below is a broad guide on how to achieve a similar outcome. Each integration will have nuances and specific commercial differences - don't hesitate to speak to your Integrations support person or sales executive for guidance.

Workflow Overview

URL Linking Structure

Jump directly out of your own applications into a valuable part of the AutoGrab product suit.

As an approved integration partner you can create buttons inside your system that link directly to parts of the AutoGrab product suite. This can create valuable user experiences for your customers giving them new abilities to explore datasets outside your platform.

The "app.autograb.com.au/" prefix applies for most users, consider if your AutoGrab customer audiences use SSO to access the app. If so you may need to dynamically update your prefix like "example.autograb.com.au/".

Brand Guidelines

How to use AutoGrabs brand correctly

The following guidelines help developers to use AutoGrabs’s brand and assets correctly and consistently where approved to do so.

Naming Apps and Integrations

When naming apps and integrations that use AutoGrab data, please follow these guidelines:

Use a unique name for your application or integration
Do not use “AutoGrab” in the name of your application or integration
Clearly state that the integration is built by you — and not AutoGrab
Do not use a name that is confusingly similar to AutoGrab or infringes on any other trademarks

Logo & Brand Usage

The logo and wordmark are the most prominent elements of the AutoGrabs brand and it’s important to use them correctly.

Detailed instructions for the usage of our brand assets are provided via our dedicated brand usage guide.

API Reference Parameter

Use this to utilise a single API key but track usage by passing a unique param per use-case or customer.

On any endpoint add the new parameter reference_id and pass in your ID.

This ID will be stored against usage records if supplied and can be used to support custom billing workflows as agreed with your account representative.

FAQ

These are frequently asked questions about AutoGrab and our products.

What is a VIN?

The car's vehicle identification number (VIN) is the identifying code for a specific automobile. The VIN serves as the car's fingerprint, as no two vehicles in operation have the same VIN. A VIN is composed of 17 characters (digits and capital letters) that act as a unique identifier for the vehicle. A VIN displays the car's unique features, specifications and manufacturer. The VIN can be used to track recalls, registrations, warranty claims, thefts and insurance coverage.

What is an Vehicle ID?

{ "success": true, "vehicles": [ { "id": "4664292750131200", "legacy_id": "4664292750131200", "badge": "TSI", "make": "Volkswagen", "model": "Polo", "series": null, "title": "2019 Volkswagen Polo TSI Manual", "year": "2019", "body_config_type": null, "body_type": "Hatchback", "drive_type": "Front Wheel Drive", "engine_type": "Piston", "fuel_type": "Petrol", "transmission_type": "Manual", "wheelbase_type": null, "capacity_cc": 999, "power_kw": 70, "torque_nm": 175, "range": null, "num_cylinders": 3, "num_doors": 5, "num_gears": 5, "num_seats": 5, "model_year": "MY19", "release_month": 7, "release_year": 2019 }, { "id": "4814155836030976", "legacy_id": "4814155836030976", "badge": "TSI", "make": "Volkswagen", "model": "Polo", "series": null, "title": "2019 Volkswagen Polo TSI Automatic", "year": "2019", "body_config_type": null, "body_type": "Hatchback", "drive_type": "Front Wheel Drive", "engine_type": "Piston", "fuel_type": "Petrol", "transmission_type": "Automatic", "wheelbase_type": null, "capacity_cc": 999, "power_kw": 70, "torque_nm": 175, "range": null, "num_cylinders": 3, "num_doors": 5, "num_gears": 7, "num_seats": 5, "model_year": "MY19", "release_month": 1, "release_year": 2019 }, { "id": "5855535618326528", "legacy_id": "5855535618326528", "badge": "TSI", "make": "Volkswagen", "model": "Polo", "series": null, "title": "2019 Volkswagen Polo TSI Automatic", "year": "2019", "body_config_type": null, "body_type": "Hatchback", "drive_type": "Front Wheel Drive", "engine_type": "Piston", "fuel_type": "Petrol", "transmission_type": "Automatic", "wheelbase_type": null, "capacity_cc": 999, "power_kw": 70, "torque_nm": 175, "range": null, "num_cylinders": 3, "num_doors": 5, "num_gears": 7, "num_seats": 5, "model_year": "MY20", "release_month": 10, "release_year": 2019 }, { "id": "5958589734715392", "legacy_id": "5958589734715392", "badge": "TSI", "make": "Volkswagen", "model": "Polo", "series": null, "title": "2019 Volkswagen Polo TSI Manual", "year": "2019", "body_config_type": null, "body_type": "Hatchback", "drive_type": "Front Wheel Drive", "engine_type": "Piston", "fuel_type": "Petrol", "transmission_type": "Manual", "wheelbase_type": null, "capacity_cc": 999, "power_kw": 70, "torque_nm": 175, "range": null, "num_cylinders": 3, "num_doors": 5, "num_gears": 5, "num_seats": 5, "model_year": "MY20", "release_month": 10, "release_year": 2019 } ], "total": 4, "confidence": "standard" }

Market Insights Snapshot

The Market Insights Snapshot system provides insights into the marketability of a given car in a marketplace.

Overview

The widget can show regionalised market insights based on input vehicles. It is customisable to your brand via a hero brand icon. The resulting market information can help your customers understand the market reception to a given vehicle.

Implementation

Speak to your sales rep about your desired implementation pattern. We will supply you with staging and production iFrame url code as part of your deployment process.

You must implement your own trigger button to launch the iframe and load in all required inputs as below.

Example Implementation Inputs

To load the iframe you need to share the following input variables.

Label

Description

Example

Requirement

Vehicle Identifier Preferences

The system will take the most economically logical identifier and fall back to others when provided with options. The preference list is below.

If provided with a Vehicle_Description it will use that.
If not, VIN will be used,
If not, Registration

If your commercial agreement does not include the VIN and Registration fallbacks the system will provide an error when a vehicle description is insufficient for any match at all.

Example Implementation iFrame

Position On Page

You have two options to embed the iframe inside your website. In both these options, it is critical that you set the iframe width to 650px and centred.

Popup - holding the iframe in a popup container and ensuring you conform to the AUTOGRAB_INSIGHTS_HIDE to event listening to close the popup container and AUTOGRAB_INSIGHTS_DIMENSIONS resize the height dynamically.

On Page - holding the iframe on a page ensuring you let us know so we can remove the close button. Since the page can still extend vertically you need to respond to the AUTOGRAB_INSIGHTS_DIMENSIONS alert.

Event Listeners

Please ensure your implementation meets the minimum event listener requirements.

The valuation widget will send messages you need to pay attention to via the iframe postMessage function. The messages are as follows.

AUTOGRAB_INSIGHTS_SUCCESS

The widget loaded successfully, no intervention is needed.

AUTOGRAB_INSIGHTS_ERROR

An exception or error was delivering the iframe contents.

AUTOGRAB_INSIGHTS_HIDE

The close button at the end of the workflow or close X in the interface has been pressed.

AUTOGRAB_INSIGHTS_DIMENSIONS

The iframe has resized due to changes in the contents. Please respond by resizing the iframe container to hold the new contents without cropping.

{ "success": true, "vehicles": [ { "id": "5364630897557504", "region": "nz", "title": "1997 Toyota Corolla Sprint Manual", "year": "1997", "make": "Toyota", "model": "Corolla", "badge": "Sprint", "series": null, "model_year": null, "release_month": 9, "release_year": 1995, "body_type": "Hatchback", "body_config": null, "transmission": "Manual", "transmission_type": "Manual", "wheelbase": null, "wheelbase_type": null, "fuel": "Petrol", "fuel_type": "Petrol", "engine": "Piston", "engine_type": "Piston", "drive": "FWD", "drive_type": "Front Wheel Drive", "num_doors": 5, "num_seats": 5, "num_gears": 5, "num_cylinders": 4, "capacity_cc": 1587, "power_kw": null, "torque_nm": null, "range": null, "options": [] }, { "id": "6033133967245312", "region": "nz", "title": "1999 Toyota Corolla Sprint Manual", "year": "1999", "make": "Toyota", "model": "Corolla", "badge": "Sprint", "series": null, "model_year": null, "release_month": 9, "release_year": 1995, "body_type": "Hatchback", "body_config": null, "transmission": "Manual", "transmission_type": "Manual", "wheelbase": null, "wheelbase_type": null, "fuel": "Petrol", "fuel_type": "Petrol", "engine": "Piston", "engine_type": "Piston", "drive": "FWD", "drive_type": "Front Wheel Drive", "num_doors": 5, "num_seats": 5, "num_gears": 5, "num_cylinders": 4, "capacity_cc": 1587, "power_kw": null, "torque_nm": null, "range": null, "options": [] }, { "id": "6563011892346880", "region": "nz", "title": "1998 Toyota Corolla Sprint Manual", "year": "1998", "make": "Toyota", "model": "Corolla", "badge": "Sprint", "series": null, "model_year": null, "release_month": 9, "release_year": 1995, "body_type": "Hatchback", "body_config": null, "transmission": "Manual", "transmission_type": "Manual", "wheelbase": null, "wheelbase_type": null, "fuel": "Petrol", "fuel_type": "Petrol", "engine": "Piston", "engine_type": "Piston", "drive": "FWD", "drive_type": "Front Wheel Drive", "num_doors": 5, "num_seats": 5, "num_gears": 5, "num_cylinders": 4, "capacity_cc": 1587, "power_kw": null, "torque_nm": null, "range": null, "options": [] } ], "total": 3 }

Customer Recapture

The Customer Recapture API allows you to upload, view and delete Customer Recapture customers.

This API requires authentication and an appropriate license attached to it.

Uploading Customer Lists

The main purpose of the Customer Recapture API is to facilitate the automated upload of new Recapture customers.

Customer lists are often very long, so the Customer Recapture API allows you to queue customer uploads without immediately processing every customer in the list. There is an endpoint to queue the upload, and separate endpoints to check the status of the upload, and cancel it, if necessary.

Upload a list of customers

A POST request to https://api.autograb.com.au/v2/recapture/upload?region=nz will initiate a new queued customer list upload.

The request body has three key parameters:

name: A name to assign to the upload, for personal reference
enable_rego_lookups: When rego lookups are enabled if the registration plate is provided, but no VIN is provided for a customer, we will perform a VIN lookup (at additional cost to you) and save the VIN along with the customer. When a customer record includes a VIN number, we can cross-reference the VIN with new vehicle listings posted in the future, and use this to verify that the car being sold is definitely the same car that you are tracking.

If you try to upload an empty list, you will receive a You must upload at least one customer record error.

Example

To perform an example request:

An example response payload is:

You can explore this request further in the .

Check upload status

Once you've queued a customer upload, you may want to check on the upload progress. Sending a GET request to /v2/recapture/upload/{UPLOAD_ID}?region=nz will return information about the upload, including the progress and the number of errors.

The key properties to check the upload progress are total_uploaded_customers and total_processed_customers. Creating a new Recapture customer consists of two steps - uploading and processing - and these two counters reflect the progress made for each of these steps.

Once total_processed_customers is equal to total_uploaded_customers, the upload is complete. If there are any unexpected errors during the upload, total_errors will increase to signify this, but total_processed_customers is inclusive of errors.

Example

To perform an example request:

An example response payload is:

Cancel an upload

If you queue a customer upload and later change your mind, you can cancel the upload, stopping the creation of any more customer records.

The response payload will include the details of the deleted upload.

Example

To perform an example request:

An example response payload is:

Viewing and updating customers

Once you have uploaded a customer list, you are able to use the Customer Recapture API to view your newly uploaded customers, as well as edit and delete individual customer records.

Get a list of all customers

You can use the /v2/recapture/customers?region={REGION} endpoint to retrieve a list of all your Recapture customers.

This list is paginated, and you can move between pages using the offset and limit query parameters.

If you want to get customer records associated with a specific upload, you can pass the unique Upload ID to the upload_id query parameter.

Example

To perform an example request:

An example response payload is:

Get an individual customer's records

You can get individual customer details using the GET method on /v2/recapture/customers/${CUSTOMER_ID}?region=nz.

Trying to look up an invalid customer ID returns the Invalid Customer ID error, and trying to look up a customer that you don't have access to returns an You don't have permission to access that customer error. If you try to look for a customer that exists in a different region than the one specified in the request, you will receive an Incorrect Region error.

Example

To perform an example request:

An example response payload is:

Update an individual customer record

If you need to make changes to an individual customer's details, you can use the PATCH method on the /v2/recapture/customers/${CUSTOMER_ID}?region=nz endpoint.

Only the fields that you specify in the request body will be affected, and providing an empty value ("") will set the field to null where applicable.

The response payload will include the updated customer object.

You can update any of the following customer properties: - client_name - mobile_number - sale_date - expiry_date

Example

To perform an example request:

An example response payload is:

Delete a customer

You can delete an individual customer by using the DELETE method on the /v2/recapture/customers/{CUSTOMER_ID}?region=nz endpoint.

The response payload includes the details of the customer that was deleted, and there is no way to retrieve the customer other than manually re-creating it.

The same error messages apply as with the Get Customer endpoint.

Example

To perform an example request:

An example response payload is:

{ region: { type: 'string', required: true, description: 'The stock item region', }, created_at: { type: 'string', required: true, description: 'ISO 8601 created at utc date and time string', }, updated_at: { type: 'string', required: true, description: 'ISO 8601 updated at utc date and time string', }, checked_at: { type: 'string', required: true, description: 'ISO 8601 checked at utc date and time string', }, stocked_at: { type: 'string', required: true, description: 'ISO 8601 stocked at utc date and time string', }, removed_at: { type: 'string', required: false, description: 'ISO 8601 removed at utc date and time string, only to be supplied for items that have been removed', }, condition: { type: 'string', required: true, description: 'The stock condition', example: 'New', }, stock_no: { type: 'string', required: false, description: 'The stock number', }, rego: { type: 'string', required: false, description: 'The registration plate', }, rego_expiry: { type: 'string', required: false, description: 'ISO 8601 rego_expiry utc date and time string', }, vin: { type: 'string', required: false, description: 'The Vehicle Identification Number', }, year: { type: 'number', required: false, description: 'The vehicle year', }, kms: { type: 'number', required: false, description: 'The vehicle odometer reading', }, color: { type: 'string', required: false, description: 'The vehicle body colour', }, description: { type: 'string', required: false, description: 'The vehicle description', }, make: { type: 'string', required: false, description: 'The vehicle make', }, model: { type: 'string', required: false, description: 'The vehicle model', }, series: { type: 'string', required: false, description: 'The vehicle series', }, badge: { type: 'string', required: false, description: 'The vehicle badge', }, tranmission: { type: 'string', required: false, description: 'The vehicle tranmission', }, location: { type: 'string', required: false, description: 'The vehicle location', }, suburb: { type: 'string', required: false, description: 'The vehicle suburb', }, postcode: { type: 'string', required: false, description: 'The vehicle postcode', }, lat: { type: 'number', required: false, description: 'The vehicle latitude', }, lng: { type: 'number', required: false, description: 'The vehicle longtitude', }, price_egc: { type: 'number', required: false, description: 'The vehicle price excluding government charges', }, price_dap: { type: 'number', required: false, description: 'The vehicle drive away price', }, purchase_price: { type: 'number', required: false, description: 'The vehicle purchase price', }, video_url: { type: 'string', required: false, description: 'The vehicle video url', }, images: { type: 'array', items: { type: 'object', properties: { url: { type: 'string', required: true, }, }, }, }, }

{ "success": true, "stockItemResult": { "id": "3842b20f-423b-4eab-b87a-69bed4582725", "region": "nz", "lead_id": "3f026858-5b0e-4221-8338-af40fb5d3865", "listing_id": null, "external_id": "000000001", "stock_feed_account_id": "1798a10c-977a-4ba8-b15b-0d9cb581b36b", "source": "ff7ff637-e4c1-40f2-9f9d-8f76d6c201fb", "listing_source": null, "listing_source_id": null, "external_vehicle_catalogue": null, "created_at": "2023-09-28T17:53:33.000Z", "updated_at": "2023-09-28T17:53:33.000Z", "checked_at": "2023-09-28T17:53:33.000Z", "stocked_at": "2023-09-28T17:53:33.000Z", "removed_at": null, "condition": "Used", "stock_no": "8567", "rego": "1REGOYG", "vin": "6FPAAAAAAAAAAAA5", "rego_expiry": "2023-09-28T00:00:00.000Z", "vehicle_id": "agv-ford-3399971153459088", "year": 2023, "compliance_year": null, "compliance_month": null, "build_year": null, "build_month": null, "make": "Ford", "model": "Transit", "badge": "350L", "series": "VO", "vehicle_title": null, "vehicle_rrp": null, "vehicle_age_years": null, "model_year": "MY23", "release_year": 2022, "release_month": 9, "body_type": "Van", "engine_type": "Piston", "transmission_type": "Automatic", "drive_type": "Front Wheel Drive", "fuel_type": "Diesel", "wheelbase_type": null, "body_config_type": null, "range": null, "power_kw": 125, "torque_nm": 390, "num_doors": 4, "num_seats": 3, "num_gears": 6, "num_cylinders": 4, "capacity_cc": 1995, "matcher_input": "year 2023 make FORD model TERRITORY series SZ badge transmission 6 SP AUTOMATIC ", "matcher_inputs": { "make": "FORD", "year": 2023, "badge": "", "model": "TERRITORY", "series": "SZ", "transmission": "6 SP AUTOMATIC" }, "kms": 150000, "color": null, "description": null, "purchase_price": null, "costs": null, "acquisition_channel": null, "purchaser": null, "est_retail": 35266, "est_trade": 29976, "price_egc": 36999, "price_dap": 55000, "price_includes_govt_charges": null, "price_egc_rel_to_est_trade": 1.234287429943955, "price_egc_diff_to_est_trade": 0.2342874299439552, "price_egc_rel_to_est_retail": 1.049140815516361, "price_egc_diff_to_est_retail": 0.04914081551636129, "video_url": null, "is_certified": null, "location_input": "", "state": null, "suburb": "Bluewood", "suburb_input": "Bluewood", "postcode": "3200", "postcode_input": "3200", "lat": 55.4324, "lng": -42.432, "formatted_location": null, "raw_payload": { "kms": 150000, "lat": 55.4324, "lng": -42.432, "vin": "6FPAAAAAAAAAAAA5", "make": "FORD", "rego": "1REGOYG", "year": 2023, "badge": "", "model": "TERRITORY", "images": [], "region": "nz", "series": "SZ", "suburb": "Bluewood", "location": "", "postcode": "3200", "stock_no": "8567", "condition": "Used", "price_dap": 55000, "price_egc": 36999, "checked_at": "2023-09-28T17:53:33Z", "created_at": "2023-09-28T17:53:33Z", "stocked_at": "2023-09-28T17:53:33Z", "updated_at": "2023-09-28T17:53:33Z", "rego_expiry": "2023-09-28T17:53:33Z", "transmission": "6 SP AUTOMATIC" }, "pipeline_state_id": 19 } }

Webhooks Integration

Receive notifications from AutoGrab system on events to power your own experiences.

The Webhooks API allows you to configure endpoints that will receive PUSH events from AutoGrab.

This API requires authentication and an appropriate license attached to it.

Webhook Events

There are several types of events that you can listen to using the Webhooks API. The names and descriptions of each of these events are included below.

You can find example payloads for each of these events at the bottom of this page.

Name

Definition

Currently, only the ping, recapture_new and price_change events are in use. You can still configure your webhooks to listen to the other events to enable these events once they are supported.

If you need immediate access to Recapture price change and delist events for your use case, please reach out to us at [email protected]

Create a new Webhook

To set up a webhook event subscriber, you'll first need to create the webhook using the webhook API.

You must provide a few options in the request body:

name: A name for the webhook. This is used for reference only.
region: The region that you want to subscribe to events in (nz)

Example

To perform an example request:

An example response payload is:

You can explore this request further in the .

Get a list of your webhooks

A GET request to /v2/webhooks?region=nz will return a list of all your configured webhooks in the given region.

Example

To perform an example request:

An example response payload is:

You can explore this request further in the .

Get the configuration of a single webhook

A GET request to /v2/webhooks/{WEBHOOK_ID}?region={REGION} will return the configuration of the webhook with the corresponding ID.

The payloads are the same as the /v2/webhooks route but only a single webhook is returned instead of an array.

If you try to access a webhook in a different region to the one specified in the request, you will receive an Invalid Region error. Additionally, accessing a webhook that your account does not have permission to view will return an You don't have permission to access that webhook error.

If you attempt to view a webhook that doesn't exist, you will receive an Invalid Webhook ID error.

Example

To perform an example request:

An example response payload is:

You can explore this request further in the .

Modify the configuration of a single webhook

A PATCH request to /v2/webhooks/{WEBHOOK_ID}?region={REGION} allows you to modify any of the properties of the corresponding Webhook.

Only the fields specified in the request body will be modified, and passing a blank ("") value will remove the property from the webhook where applicable.

The response includes the updated webhook, as well as a map of every property that changed.

The same errors as the above (GET /v2/webhooks/${WEBHOOK_ID}) request apply, and a Request validation failed error may also be thrown if you provide any invalid Webhook Event names. Refer to the top of this page for a list of Webhook Events and their descriptions.

Example

To perform an example request:

An example response payload is:

You can explore this request further in the .

Delete a webhook

A DELETE request to /v2/webhooks/{WEBHOOK_ID}?region={REGION} will permenantly delete the webhook.

The response payload includes the configuration of the deleted webhook, as seen in the examples below.

You may receive a small number of additional messages on your webhook's endpoint after deleting the webhook due to queued messages being sent through, but no new messages will be sent to your webhook after it has been deleted, and there is no way to recover the webhook without re-creating it.

Example

To perform an example request:

An example response payload is:

You can explore this request further in the .

Ping a webhook

A POST request to /v2/webhooks/{WEBHOOK_ID}/ping?region={REGION} will send a ping event to your webhook with an example payload.

You can't explicitly subscribe to ping events, as it is a special event type that is only sent when requested using this endpoint.

Example

To perform an example request:

An example response payload is:

You can explore this request further in the .

Webhook Payloads

Example payloads for the webhook events that are currently in use are included below.

`ping`

`recapture_new`

`valuation_change`

{ // The Webhook Event type (required) "event": "recapture_new", // The Webhook Event payload (required) "data": { // The Recapture record which has been seen online "customer": { // The internal ID of the Recapture client (required) "id": "05df2f33-1d03-404c-b0c2-dfbecaa65fff", // Required // The ISO timestamp when the event took place (required) "last_updated": "2022-09-03T00:37:57.095Z", // The registration plate that you were tracking (nullable) "rego": "BMT038", // The VIN uploaded for the Recapture customer (nullable) "vin": null, // The name uploaded for the Recapture Customer (nullable) "client_name": "Raph", // The mobile number uploaded for the Recapture Customer (nullable) "mobile_number": "+61 123 456 789", // The ISO formatted sale date uploaded alongside the customer record, if applicable (nullable) "sale_date": "2022-03-02T00:00:00.000Z", // The ISO formatted expiry date for the Recapture customer record, if applicable (nullable) "expiry_date": "2022-11-20T00:00:00.000Z", // The vehicle title, determined by a registration or listing lookup (nullable) "vehicle_title": "2019 Volkswagen Polo 85TSI Comfortline", // Any additional data that was uploaded alongside the customer record (required) "additional_fields": { "notes": "Three free services included in the package" }, // An array including details for each time one of the customer's vehicles was spotted online (required) "sightings": [ { // The date when the vehicle was spotted online (required) "at": "2022-09-03T00:37:57.095Z", // The Lead ID that includes the listing where the vehicle was spotted online (required) "lead_id": "nz_volkswagen_bmt038", // The URL where the vehicle was listed online (required) "listing_url": "https://autotrader.co.nz/used-cars-for-sale/volkswagen/polo/806849", // The title of the listing (required) "listing_title": "2019 Volkswagen Polo 85TSI Comfortline AW Auto MY19", // The price that the vehicle was listed for at the time of capture (nullable) "listing_price": 26890, } ] } } }

{ // The Webhook Event type (required) "event": "valuation_change", // The webhook event payload (required) "data": { // The pricing record which has changed in value "pricing_record": { // The unique Pricing Record ID (required) "id": "a9fb47f6-3d1d-4945-9f4d-f45b12a63797", // The AutoGrab Vehicle ID associated with the pricing record (required) "vehicle_id": "5478860653068288", // The ISO timestamp when the pricing record was first created (required) "created_at": "2022-08-20T07:20:32.412Z", // The registration plate associated with the pricing record (nullable) "rego": "ZXX678", // The registration state associated with the pricing record, if applicable (nullable) "state": "VIC", // The VIN associated with the pricing record (nullable) "vin": null, // The odometer input for the pricing record (required) "kms": 32000, // The current price prediction for the given vehicle at the kilometers entered (required) "price": 36782, // The current predicted retail price (required) "retail_price": 36782, // The current predicted trade price (required) "trade_price": 32100, // The adjustments and overrides that are currently applied to the pricing record (nullable) // Matches the adjustment schema from the `/v2/valuations/predict` endpoint "adjustment": null, // An array of all the recorded valuation changes that this pricing record has had (required) "changes": [ { // The unique change ID (required) "id": "ba4b3912-ae25-44c1-8a66-36ca68fac859", // The change type (valuation or configuration) (required) // A valuation change implies that the market has shifted, // whereas a configuration change is simply a result of your // adjustments/overrides configuration changing "type": "valuation", // The ISO timestamp when the change occurred (required) "at": "2022-09-03T01:03:55.382Z", // The new price (required) "new_price": 36782, // The new retail price (required) "new_retail_price": 36782, // The new trade price (required) "new_trade_price": 32100, // The old price (required) "old_price": 38520, // The old retail price (required) "old_retail_price": 38520, // The old trade price (required) "old_trade_price": 34200 }, { // Any previous changes to the pricing record will also be // included here, following the same schema as above "id": "46610b56-f3c7-4744-8adf-021c0aba1cc4", "type": "configuration", "at": "2022-09-01T03:12:32.524Z", "new_price": 38520, "new_retail_price": 38520, "new_trade_price": 34200, "old_price": 38520, "old_retail_price": 37520, "old_trade_price": 33900 } ] }, // This is a copy of the specific valuation change that caused the webhook to trigger (required) // in case many changes occur in a short time span, this is the source of truth for the // exact change that triggered the event. "change": { "id": "ba4b3912-ae25-44c1-8a66-36ca68fac859", "type": "valuation", "at": "2022-09-03T01:03:55.382Z", "new_price": 36782, "new_retail_price": 36782, "new_trade_price": 32100, "old_price": 38520, "old_retail_price": 38520, "old_trade_price": 34200 } } }

Registration Plate Search

Find vehicle information from a registration plate.

Overview

The Vehicle Registration API allows you to search for a vehicle by supplying its number plate. The request requires a region, the state (dependent on region), number plate & API key. This will return either a matching vehicle with possible option packs, or a null.

In all cases, and importantly if a matching vehicle is unable to be identified, we will return the upstream_vehicle field allowing you to identify how the relevant road transport authority describes the vehicle. Depending on your use case you may wish to allow front-end users to manually classify the vehicle using the upstream_vehicle as a guide to fill out a Facet-style.

That would produce the payload below.

Components

Success - this denotes the outcome of the lookup, if this is not true there are several possible reasons. The plate does not exist, was entered incorrectly or the registration authority could be experiencing an outage ().

Vehicle - this is the array that holds the vehicle data as a result of our matching operation. If Vehicle:Null then we have not been able to identify a matching vehicle. If this is powering a front end UX, you should prompt the user to search via to resolve to an vehicle ID. You can use the Upstream_Vehicle below as a UI guide.

Upstream_Vehicle - this is what the Registration Authority has told us the vehicle is. We use this input to match our catalogue.

ID - this is the platform ID of the vehicle, your gateway to leveraging this vehicle in future , and more requests.

Summary Data - you will find basic information about the vehicle that you can use to power your UX. If you require more information that is in the Vehicle array consider usage of endpoints.

Options - these are fittable (not fitted) options available on this vehicle. If you require fitted (from factory data) use the endpoint.

Confidence - this is the prediction confidence of the match. There are two types of output for this parameter (Standard and degraded).

Additional Vehicle - if there are additional lower confidence matches we will show them to you here.

Features

You can pass in features to request additional data to be sent in the response. Refer to the section for more information.

Prefer More Results

This feature will show you additional results at lower-quality matches. Only use this if you would like to see other vehicles that are not likely to be the one you are requesting. Use headerprefer_more_results=true to request this response.

🇳🇿 NZ AutoGrab API Doc

AutoGrab Basics

AutoGrab Developer Hub

Integration Overview

hashtagOverview

hashtag

API Test Cases

hashtagTest Cases

hashtagSupported Endpoints

hashtagImplementation Guide

Authentication

Basic Key Based Authentication

hashtagKey Types

hashtagSecret API Key

hashtagPublic API Key

hashtagAuthenticating Requests

hashtagOther Authentication Methods

OAuth Authentication

hashtagToken management

hashtagauth-broker POST call to receive a valid OAuth token

hashtagREST API call signing

hashtagTroubleshooting

Vehicle Search

Vehicle Searching Basics

Plain-text Search

hashtagExample

VIN Search

Facet Search

hashtagSearch for Vehicles by facets

hashtagFacets User Interface Example

Marketplace ID Lookup

hashtagOverview

Vehicle ID Search

Matching Confidence

Sourcing

Sourcing Basics

Features

hashtagDealer Contact Details

Market Statistics

hashtagOverview

Vehicle Data

Vehicle Data Basics

Valuation

Valuation Basics

Valuation Predictions

hashtagOverview

Adjustments

hashtagRecommended Retail Price Adjustment

Condition Array

Valuation Features

hashtagValuation Bounds

Residual Valuations

Registration & VIN Valuations

hashtagRegistration Valuation

Valuation Features

Max Offer Configuration

AutoGauge

hashtagExample Post Body

Embeddable Products

Embeddable Basics

Valuation Widget

hashtagOverview

Other Products & Resources

Pre-Accident Valuation API Suite

hashtagWorkflow Overview

URL Linking Structure

Brand Guidelines

hashtagNaming Apps and Integrations

hashtagLogo & Brand Usage

API Reference Parameter

FAQ

Basic Key Based Authentication

hashtagKey Types

hashtagSecret API Key

hashtagPublic API Key

hashtagAuthenticating Requests

hashtagOther Authentication Methods

AutoGrab Developer Hub

Integration Overview

hashtagOverview

Overview

Test Cases

Supported Endpoints

Implementation Guide

Key Types

Secret API Key

Public API Key

Authenticating Requests

Other Authentication Methods

Token management

auth-broker POST call to receive a valid OAuth token

REST API call signing

Troubleshooting

Example

Search for Vehicles by facets

Facets User Interface Example

Overview

Dealer Contact Details

Overview

Overview

Recommended Retail Price Adjustment

Valuation Bounds

Registration Valuation

Example Post Body

Overview

Workflow Overview

Naming Apps and Integrations

Logo & Brand Usage

Key Types

Secret API Key

Public API Key

Authenticating Requests

Other Authentication Methods

Overview

Regions

Region

API Keys

Quota Limits

Rate Limiting

Token management

auth-broker POST call to receive a valid OAuth token

REST API call signing

Troubleshooting

Test Cases

Supported Endpoints

Implementation Guide

Search for Vehicles by facets

Facets User Interface Example

Overview

Naming Apps and Integrations

Logo & Brand Usage

Valuation Bounds

Overview

Example Post Body

Registration Valuation

Overview

Workflow Overview

Implementation

Position On Page

Event Listeners

Sourcing

MyListings

Example Usage

Limitations