LogoLogo
API StatusSupportPostmanContact Us
🇳🇿 NZ AutoGrab API Doc
🇳🇿 NZ AutoGrab API Doc
  • AutoGrab Basics
    • AutoGrab Developer Hub
    • Integration Overview
    • Open API Reference
    • API & System Status
    • API Test Cases
  • Authentication
    • Basic Key Based Authentication
    • OAuth Authentication
  • Vehicle Search
    • Vehicle Searching Basics
    • Plain-text Search
    • Registration Plate Search
    • VIN Search
    • Facet Search
      • Facet Integration Worked Example
    • Marketplace ID Lookup
    • Vehicle ID Search
    • Matching Confidence
  • Sourcing
    • Sourcing Basics
    • Market Overlay
      • Features
    • Market Statistics
  • Vehicle Data
    • Vehicle Data Basics
    • Vehicle History
    • Factory Build Data
  • Valuation
    • Valuation Basics
    • Valuation Predictions
      • Adjustments
      • Condition Array
      • Valuation Features
    • Residual Valuations
    • Registration & VIN Valuations
    • Valuation Features
    • Max Offer Configuration
    • AutoGauge
  • Embeddable Products
    • Embeddable Basics
    • AutoGauge
    • Valuation Widget
    • Market Insights Snapshot
  • Other Products & Resources
    • Pre-Accident Valuation API Suite
    • URL Linking Structure
    • Webhooks Integration
    • Customer Recapture
    • Brand Guidelines
    • API Reference Parameter
    • Stock Feeds
    • FAQ
Powered by GitBook
LogoLogo

Links

  • Terms of Use

2024 © AutoGrab Pty Ltd. ABN 79 638 468 569

On this page
  • Real-Time Pricing
  • Sourcing
  • MyListings

Was this helpful?

Export as PDF
  1. Other Products & Resources

URL Linking Structure

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

PreviousPre-Accident Valuation API SuiteNextWebhooks Integration

Was this helpful?

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/".

Real-Time Pricing

At a minimum, a vehicle ID parameter must be included in the URL, as you can see below: You will need to include a rego, vin and/or state parameter to pre-fill the registration search box without running a rego lookup. This will associate the pricing record with the correct rego and VIN and enable easy access to PPSR lookups as those details will also be pre-filled: Ideally, the odometer reading should also be passed in the URL, otherwise, it will default to 0kms. You can use the odometer input with or without the rego/vin inputs, but the vehicle ID is always required. The expected integration pattern assumes your user has access to app.autograb already. If they are not signed in they will be asked to. You can find the vehicle ID by using a v as you would have already done in your product.

This URL strategy will not submit the valuation request, your user will need to push the button.

Sourcing

To jump to a specific vehicle in sourcing you can provide identifiers in the following URL patterns. If the identifier is not able to be matched to a vehicle in sourcing we will notify the user of this in app.

Identifier
URL Example

Lead ID

https://app.autograb.com.au/sourcing/leads/3394e05f-281d-477d-9a4d-3c361307acaf

VIN

https://app.autograb.com.au/sourcing?vin=6G1ZX54775L481373

Registration Plate

https://app.autograb.com.au/sourcing?rego=S075AMU

MyListings

To jump to a specific vehicle in MyListings you can provide identifiers in the following URL patterns. If you pass in an identifier that is not associated with the logged in dealer we will show an error popup notifying the user of this.

Identifier
URL Example

Lead ID

https://app.autograb.com.au/portfolio?lead_id=d0233c61-f4b9-4e3e-87c7-66fca7731005

VIN

https://app.autograb.com.au/portfolio?vin=7AT0H61YX14006214

Registration Plate

https://app.autograb.com.au/portfolio?rego=1GAJ330

https://app.autograb.com.au/pricing?vehicleId=6673067719786496
https://app.autograb.com.au/pricing?vehicleId=6673067719786496&rego=CER226&vin=WBATR92040LE26311&state=VIC
https://app.autograb.com.au/pricing?vehicleId=6673067719786496&rego=CER226&vin=WBATR92040LE26311&state=VIC&kms=10000
ehicle search mechanism