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
  • Creating a stock feed
  • Stock item schema
  • Posting stock items

Was this helpful?

Export as PDF
  1. Other Products & Resources

Stock Feeds

Pipe your stock feed into a range of AutoGrab products.

Creating a stock feed

Your organisation will need at least one stock feed before uploading stock to the platform.

To create a stock feed, make a single POST request to the following Autograb API:

POST /v2/stock?region=nz

Sample response:

{
    "success": true,
    "stockFeed": {
        "id": "ff7ff637-e4c1-40f2-9f9d-8f76d6c201fb",
        "display_name": "ff7ff637-e4c1-40f2-9f9d-8f76d6c201fb",
        "stock_feed_api_keys": [
            "YOUR_API_KEY"
        ]
    }
}

The stock feed ID is required to post stock items to Autograb. Please note the stock feed is linked to your API key, so you will need to use the same API key when posting stock items to the stock feed.

Stock item schema

Stock items must be posted in a format that complies with the Stock item schema:

{
  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,
        },
      },
    },
  },
}

Posting stock items

To post a stock item, make a single POST request to the following Autograb API:

POST /v2/stock/{stock_feed_id}/{external_dealership_id}/{external_id}?region=nz

The post payload should be the stock item payload, as detailed above. Note that you need to provide your stock_feed_id, as well as external_dealership_id (that is, your own dealership identifier external to Autograb) and the stock item external_id (that is, your own stock item identifier, external to Autograb).

Note that the system allows a single stock feed to contain stock items across multiple dealerships

When you post stock to Autograb, the system will overwrite any previous stock with the latest details contained in the post payload.

Sample response:

{
    "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
    }
}
PreviousAPI Reference ParameterNextFAQ

Last updated 1 year ago

Was this helpful?