Field Attributes
This page give in detail view of field attributes included in the request payload of inventory webhook
Quick Reference – Webhook Payload Fields
Section titled “Quick Reference – Webhook Payload Fields”| Section | Key Fields (Examples) | Notes / Purpose |
|---|---|---|
| Identification | Type, Identifier, ListingType, SaleStatus |
Core identity of the stock |
| Details | Description, Slug, BuildDate, ComplianceDate |
Vehicle description & compliance |
| Pricing | PriceList, SubscriptionPricing |
Retail pricing (EGC, DAP) and optional subscription pricing |
| Odometer | OdometerReadings |
Includes value and unit (e.g. KM, miles) |
| Registration | Number, ExpiresUtc |
Registration plate and expiry |
| Specifications | Make, Model, Series, Attributes, RedBookCode |
Full tech spec, RedBook integration if present |
| Seller | Identifier, Name, Contact, Addresses |
Dealer contact and location info |
| Media | Photos[], Large, Thumb |
Vehicle image URLs |
| Features | Features[] |
Interior/exterior features, grouped by category |
| Certification | Certified, CertificationType |
Whether vehicle is certified |
| VendorData | Autogauge, ThirdPartyData |
Optional integrations (e.g. price intelligence) |
| Meta Info | CreatedUtc, LastModifiedUtc |
Timestamps for updates |
| Destinations | Website, Portals[] |
Where the listing is being published |
Field mappings in detail as follows
Main Fields
Section titled “Main Fields”| Field | Required? | Description |
|---|---|---|
| Type | Yes | Default: CAR |
| Identifier | Yes | Internal Inventory ID in Dealer Studio |
| ListingType | Yes | Inventory Type – one of new, used, demo |
| SaleStatus | Yes | Either For Sale or WITHDRAWN |
| SaleType | Yes | Default: Retail |
| Description | Yes | Dealer-comments or new arrival notes. If none, still present. |
| Slug | Yes | URL-friendly identifier derived from stock details |
| Registration | Yes | An object containing registration fields (see sub-table) |
| Identification | Yes | Array of identification types (StockNumber, VIN, etc.), may be empty |
| Colours | No | Array of interior/exterior colour details; can be empty |
| OdometerReadings | Yes | Array of size 1 (currently) with odometer reading data |
| Seller | Yes | Dealer / seller details with address, contact, identifiers etc. |
| Specification | Yes | Vehicle spec details (Make, Model, Series, etc.) including RedBook source if available |
| Features | Yes | Categorised features if available; otherwise null |
| Media | Yes | Photo attachments (URLs for medium, large, thumb sizes) |
| ComplianceDate | Yes | Month & Year when vehicle meets compliance standards (e.g. safety, environmental) |
| BuildDate | Yes | Month & Year of manufacture / assembly |
| Warranty | Yes | Currently empty object {}, but will map detailed warranty in future |
| PriceList | Yes | Array of pricing types (DAP, EGC, BeforePrice), currency (AUD), amounts |
| Certification | Yes | Certified status (boolean); certification type may be null if none. |
| LastModifiedUtc | Yes | Timestamp of last update in DS |
| CreatedUtc | Yes | Timestamp when inventory record was first created in DS |
| VendorData | Yes | Third-party extras (e.g. Autograb) with additional market & listing info |
| Destinations | Yes | List of external display destinations (websites etc.) where the listing appears |
| SubscriptionPricing | No | Only included for certain third parties; contains pricing breakdowns (weekly, monthly etc.) |
Here are some of the nested structures with descriptions:
Registration Sub-Fields
Section titled “Registration Sub-Fields”| Sub-field | Required? | Description |
|---|---|---|
| Number | Yes | Registration plate number of the vehicle |
| ExpiresUtc | Yes | Registration expiry date in UTC format |
Identification (array items)
Section titled “Identification (array items)”| Sub-field | Required? | Description |
|---|---|---|
| Type | Yes | e.g. StockNumber, VIN |
| Value | Yes | Value corresponding to that identifier |
Colours (array items)
Section titled “Colours (array items)”| Sub-field | Required? | Description |
|---|---|---|
| Location | Yes | Either Exterior or Interior |
| Name | Yes | Name of the colour; list of known colours or any custom if provided |
OdometerReadings (array of max 2 item)
Section titled “OdometerReadings (array of max 2 item)”| Sub-field | Required? | Description |
|---|---|---|
| Type | Yes | (currently blank) placeholder for reading type |
| Value | Yes | Numeric odometer reading |
| UnitOfMeasure | Yes | e.g. KM |
Seller Sub-Fields
Section titled “Seller Sub-Fields”| Sub-field | Required? | Description |
|---|---|---|
| Identifier | Yes | Dealer’s DS-internal ID |
| Type | Yes | Usually Dealer |
| Name | Yes | Dealer name |
| ExternalIdentifiers | No | Other codes mapped (manufacturer, location etc.) |
| LocationCode, LocationName, LocationId | No | Location details within DS |
| Logo | No | Dealership Logo url |
| DealerLicenceNumber | No | Licence number for the dealership location |
| Addresses | No | Address(es) of this dealership/location |
| Contact | No | Contact phone, operating hours etc. |
Specification Sub-Fields
Section titled “Specification Sub-Fields”| Sub-field | Required? | Description |
|---|---|---|
| Identifier | Yes | Same as inventory ID in DS |
| SpecificationSource | Yes | E.g. REDBOOK when enriched by RedBook data |
| SpecificationCode | No | RedBook code if exists; otherwise null |
| description | No | Additional description text if provided |
| CountryCode | Yes | e.g. AU |
| Make, Model | Yes | Vehicle make and model |
| Series | No | Series if available |
| ReleaseDate | Yes | Year of release as object (e.g. {"Year": 2023}) |
| Title | Yes | Full title for the inventory stock item |
| Attributes | Yes | Array of named spec fields like engine size, fuel type, doors etc. Can be empty |
Media Sub-Fields
Section titled “Media Sub-Fields”| Sub-field | Required? | Description |
|---|---|---|
| Photos | No | Array of photo objects; may be empty |
| Url | Yes | Medium-sized photo URL |
| Large | Yes | Large version of photo as object with a Url sub-field |
| Thumb | Yes | Thumbnail version URL object |
Photos Fields
Section titled “Photos Fields”| Field | Required? | Description |
|---|---|---|
| Url | Yes | URL of the medium photo. Resolution: 1200x800 |
| Large | Yes | Large image object: { Url: "<url_large_size>" }. Resolution: 1500x1000 |
| Thumb | Yes | Thumbnail image object: { Url: "<url_thumb_size>" }. Resolution: 600x400 |
ComplianceDate Fields
Section titled “ComplianceDate Fields”| Field | Required? | Description |
|---|---|---|
| Month | No | Month of compliance (01-12) |
| Year | No | Year of compliance (e.g., 2023) |
BuildDate Fields
Section titled “BuildDate Fields”| Field | Required? | Description |
|---|---|---|
| Month | No | Month of build (01-12) |
| Year | No | Year of build (e.g., 2023) |
PriceList Fields
Section titled “PriceList Fields”PriceList can be an empty array or contain multiple entries with the following structure:
| Field | Required? | Description |
|---|---|---|
| Type | Yes | Type of price: DAP, EGC, or BeforePrice |
| Currency | Yes | Currency code. Default: AUD |
| Amount | Yes | Numeric amount corresponding to the type |
Certification Fields
Section titled “Certification Fields”| Field | Required? | Description |
|---|---|---|
| Certified | Yes | Boolean value: true or false |
| CertificationType | No | Type of certification. Can be null if not present |
VendorData Fields
Section titled “VendorData Fields”| Field | Required? | Description |
|---|---|---|
| Identifier | No | Default: "autograb" |
| Data | No | Contains additional stock insights from Autograb or third-party systems |
Destinations Sub-Fields
Section titled “Destinations Sub-Fields”| Sub-field | Required? | Description |
|---|---|---|
| Type | Yes | Default to Dealer Website |
| URL | Yes | Stock accessible url through that website |
| Name | Yes | Name of the website the stock is shown on |