object
(JsonLead)
Property | Type | Required | Nullable | Defined by |
---|---|---|---|---|
version | string |
Required | cannot be null | JsonLead |
customer | object |
Required | cannot be null | JsonLead |
sales_lead | object |
Optional | cannot be null | JsonLead |
appraisal_lead | object |
Optional | cannot be null | JsonLead |
aftersales_lead | object |
Optional | cannot be null | JsonLead |
Version of the JSONLead schema
version
is required
Type: string
cannot be null
defined in: JsonLead
string
constant: the value of this property must be equal to:
"https://jsonlead.org/2.0.0/schema"
The default value is:
"https://jsonlead.org/2.0.0/schema"
The customer object
customer
object
(Customer)
The sales lead.
sales_lead
is optional
Type: object
(Sales lead)
cannot be null
defined in: JsonLead
object
(Sales lead)
The appraisal lead.
appraisal_lead
is optional
Type: object
(Appraisal lead)
cannot be null
defined in: JsonLead
object
(Appraisal lead)
The aftersales lead.
aftersales_lead
is optional
Type: object
(Aftersales lead)
cannot be null
defined in: JsonLead
object
(Aftersales lead)
Reference this group by using
{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v2.0.0.schema.json#/definitions/gdpr"}
Property | Type | Required | Nullable | Defined by |
---|---|---|---|---|
provider | object |
Optional | cannot be null | JsonLead |
created_at | string |
Optional | cannot be null | JsonLead |
marketing | boolean |
Optional | cannot be null | JsonLead |
profiling | boolean |
Optional | cannot be null | JsonLead |
third_party | boolean |
Optional | cannot be null | JsonLead |
provider
is optional
Type: object
(GDPR Provider)
cannot be null
defined in: JsonLead
object
(GDPR Provider)
The creation date of the consent. Should follow ISO 8601 (2024-02-06T15:26:17.683Z)
created_at
is optional
Type: string
cannot be null
defined in: JsonLead
string
date time: the string must be a date time string, according to RFC 3339, section 5.6
Whether or not the customer has given consent to receive marketing communications
marketing
is optional
Type: boolean
cannot be null
defined in: JsonLead
boolean
Whether or not the customer has given consent to use his or her data for profiling
profiling
is optional
Type: boolean
cannot be null
defined in: JsonLead
boolean
Whether or not the customer has given consent to send his data to third party companies
third_party
is optional
Type: boolean
cannot be null
defined in: JsonLead
boolean
Reference this group by using
{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v2.0.0.schema.json#/definitions/address"}
Property | Type | Required | Nullable | Defined by |
---|---|---|---|---|
country | string |
Optional | cannot be null | JsonLead |
area_level_1 | string |
Optional | cannot be null | JsonLead |
area_level_2 | string |
Optional | cannot be null | JsonLead |
area_level_3 | string |
Optional | cannot be null | JsonLead |
postal_code | string |
Optional | cannot be null | JsonLead |
locality | string |
Optional | cannot be null | JsonLead |
route | string |
Optional | cannot be null | JsonLead |
street_number | string |
Optional | cannot be null | JsonLead |
address_details | string |
Optional | cannot be null | JsonLead |
Country code of the address (Following ISO 3166-1 alpha-2)
country
string
(Country)
Level 1 administrative division of the address (Community, State). See https://en.wikipedia.org/wiki/List_of_administrative_divisions_by_country for more information
area_level_1
is optional
Type: string
(Area level 1)
cannot be null
defined in: JsonLead
string
(Area level 1)
Level 2 administrative division of the address (Province, County). See https://en.wikipedia.org/wiki/List_of_administrative_divisions_by_country for more information
area_level_2
is optional
Type: string
(Area level 2)
cannot be null
defined in: JsonLead
string
(Area level 2)
Level 3 administrative division of the address (French arrondissements). See https://en.wikipedia.org/wiki/List_of_administrative_divisions_by_country for more information
area_level_3
is optional
Type: string
(Area level 3)
cannot be null
defined in: JsonLead
string
(Area level 3)
Postal code of the address
postal_code
is optional
Type: string
(Postal Code)
cannot be null
defined in: JsonLead
string
(Postal Code)
Municipalities of the address (Town, City)
locality
string
(Locality)
Street name of the address
route
string
(Route)
Street number of the address
street_number
is optional
Type: string
(Street number)
cannot be null
defined in: JsonLead
string
(Street number)
Additional details about the address
address_details
is optional
Type: string
(Adress details)
cannot be null
defined in: JsonLead
string
(Adress details)
Reference this group by using
{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v2.0.0.schema.json#/definitions/customer"}
Property | Type | Required | Nullable | Defined by |
---|---|---|---|---|
ids | array |
Optional | cannot be null | JsonLead |
created_at | string |
Optional | cannot be null | JsonLead |
business_details | object |
Optional | cannot be null | JsonLead |
contacts | array |
Optional | cannot be null | JsonLead |
address | object |
Optional | cannot be null | JsonLead |
owned_vehicles | array |
Optional | cannot be null | JsonLead |
custom | object |
Optional | cannot be null | JsonLead |
A list of unique identifiers from your -and/or third party- databases or systems. This ID can be used by lead managers to corss-reference and update customer information
ids
is optional
Type: string[]
cannot be null
defined in: JsonLead
string[]
The creation date of the customer. Should follow ISO 8601 (2024-02-06T15:26:17.683Z)
created_at
is optional
Type: string
cannot be null
defined in: JsonLead
string
date time: the string must be a date time string, according to RFC 3339, section 5.6
For business accounts, information related to the company
business_details
object
(Details)
contacts
object[]
(Details)
Addess of the customer
address
object
(Details)
owned vehicles of the customer
owned_vehicles
an array of merged types (Details)
Custom fields for the customer
custom
object
(Details)
Reference this group by using
{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v2.0.0.schema.json#/definitions/aftersales_lead"}
Property | Type | Required | Nullable | Defined by |
---|---|---|---|---|
created_at | string |
Optional | cannot be null | JsonLead |
ids | array |
Optional | cannot be null | JsonLead |
assigned_to | string |
Optional | cannot be null | JsonLead |
status | string |
Optional | cannot be null | JsonLead |
status_history | object |
Optional | cannot be null | JsonLead |
type | string |
Optional | cannot be null | JsonLead |
vehicle | Merged | Optional | cannot be null | JsonLead |
origin | object |
Optional | cannot be null | JsonLead |
dealer_location | string |
Optional | cannot be null | JsonLead |
tasks | array |
Optional | cannot be null | JsonLead |
offers | array |
Optional | cannot be null | JsonLead |
appointments | array |
Optional | cannot be null | JsonLead |
comments | array |
Optional | cannot be null | JsonLead |
related_urls | array |
Optional | cannot be null | JsonLead |
custom | object |
Optional | cannot be null | JsonLead |
The creation date of the lead. Should follow ISO 8601 (2024-02-06T15:26:17.683Z)
created_at
is optional
Type: string
cannot be null
defined in: JsonLead
string
date time: the string must be a date time string, according to RFC 3339, section 5.6
A list of unique identifiers that originates from an external database or system. It is meant to cross-reference the aftersales lead on the destination database with the external system.
ids
is optional
Type: string[]
cannot be null
defined in: JsonLead
string[]
The user assigned to the aftersale
assigned_to
is optional
Type: string
cannot be null
defined in: JsonLead
string
The aftersales lead current status
status
is optional
Type: string
cannot be null
defined in: JsonLead
string
The aftersales lead status history
status_history
object
(Details)
The type of the lead
type
is optional
Type: string
cannot be null
defined in: JsonLead
string
The vehicle associated with this aftersale
vehicle
merged type (Details)
all of
The aftersale origin
origin
object
(Origin)
The location of the aftersale
dealer_location
is optional
Type: string
cannot be null
defined in: JsonLead
string
Task objects to associate with the aftersale
tasks
object[]
(Task)
Offer objects to associate with the aftersale
offers
object[]
(Offer)
Appointment objects to associate with the aftersale
appointments
is optional
Type: object[]
(Appointment)
cannot be null
defined in: JsonLead
object[]
(Appointment)
Comment objects to associate with the aftersale
comments
object[]
(Comment)
An array of URLs with information related to the aftersale
related_urls
is optional
Type: string[]
cannot be null
defined in: JsonLead
string[]
Custom fields for the aftersale
custom
object
(Details)
Reference this group by using
{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v2.0.0.schema.json#/definitions/sales_lead"}
Property | Type | Required | Nullable | Defined by |
---|---|---|---|---|
created_at | string |
Optional | cannot be null | JsonLead |
finance | object |
Optional | cannot be null | JsonLead |
ids | array |
Optional | cannot be null | JsonLead |
assigned_to | string |
Optional | cannot be null | JsonLead |
status | string |
Optional | cannot be null | JsonLead |
status_history | object |
Optional | cannot be null | JsonLead |
vehicles | array |
Optional | cannot be null | JsonLead |
origin | object |
Optional | cannot be null | JsonLead |
type | string |
Optional | cannot be null | JsonLead |
dealer_location | string |
Optional | cannot be null | JsonLead |
inquiry | string |
Optional | cannot be null | JsonLead |
tasks | array |
Optional | cannot be null | JsonLead |
offers | array |
Optional | cannot be null | JsonLead |
appointments | array |
Optional | cannot be null | JsonLead |
comments | array |
Optional | cannot be null | JsonLead |
related_urls | array |
Optional | cannot be null | JsonLead |
custom | object |
Optional | cannot be null | JsonLead |
The creation date of the lead. Should follow ISO 8601 (2024-02-06T15:26:17.683Z)
created_at
is optional
Type: string
cannot be null
defined in: JsonLead
string
date time: the string must be a date time string, according to RFC 3339, section 5.6
Information about the finance operation
finance
object
(Details)
A list of unique identifiers that originates from an external database or system. It is meant to cross-reference the sales lead on the destination database with the external system.
ids
is optional
Type: string[]
cannot be null
defined in: JsonLead
string[]
The user assigned to the sale
assigned_to
is optional
Type: string
cannot be null
defined in: JsonLead
string
The sales lead current status
status
is optional
Type: string
cannot be null
defined in: JsonLead
string
The sales lead status history
status_history
object
(Details)
The vehicles associated with this sale
vehicles
an array of merged types (Details)
The origin of the sale
origin
object
(Origin)
The type of the lead
type
is optional
Type: string
cannot be null
defined in: JsonLead
string
The location of the sale
dealer_location
is optional
Type: string
cannot be null
defined in: JsonLead
string
The sale inquiry
inquiry
is optional
Type: string
cannot be null
defined in: JsonLead
string
Task objects to associate with the sale
tasks
object[]
(Task)
Offer objects to associate with the sale
offers
object[]
(Offer)
Appointment objects to associate with the sale
appointments
is optional
Type: object[]
(Appointment)
cannot be null
defined in: JsonLead
object[]
(Appointment)
Comment objects to associate with the sale
comments
object[]
(Comment)
An array of URLs with information related to the sale
related_urls
is optional
Type: string[]
cannot be null
defined in: JsonLead
string[]
Custom fields for the sale
custom
object
(Details)
Reference this group by using
{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v2.0.0.schema.json#/definitions/appraisal_lead"}
Property | Type | Required | Nullable | Defined by |
---|---|---|---|---|
created_at | string |
Optional | cannot be null | JsonLead |
ids | array |
Optional | cannot be null | JsonLead |
assigned_to | string |
Optional | cannot be null | JsonLead |
status | string |
Optional | cannot be null | JsonLead |
status_history | object |
Optional | cannot be null | JsonLead |
vehicles | array |
Optional | cannot be null | JsonLead |
origin | object |
Optional | cannot be null | JsonLead |
type | string |
Optional | cannot be null | JsonLead |
dealer_location | string |
Optional | cannot be null | JsonLead |
appraisal_value | number |
Optional | cannot be null | JsonLead |
tasks | array |
Optional | cannot be null | JsonLead |
offers | array |
Optional | cannot be null | JsonLead |
appointments | array |
Optional | cannot be null | JsonLead |
comments | array |
Optional | cannot be null | JsonLead |
related_urls | array |
Optional | cannot be null | JsonLead |
custom | object |
Optional | cannot be null | JsonLead |
The creation date of the lead. Should follow ISO 8601 (2024-02-06T15:26:17.683Z)
created_at
is optional
Type: string
cannot be null
defined in: JsonLead
string
date time: the string must be a date time string, according to RFC 3339, section 5.6
A list of unique identifiers that originates from an external database or system. It is meant to cross-reference the appraisal lead on the destination database with the external system.
ids
is optional
Type: string[]
cannot be null
defined in: JsonLead
string[]
The username assigned to the appraisal
assigned_to
is optional
Type: string
cannot be null
defined in: JsonLead
string
The appraisal lead current status
status
is optional
Type: string
cannot be null
defined in: JsonLead
string
The appraisal lead status history
status_history
object
(Details)
vehicles
an array of merged types (Details)
The appraisal origin
origin
object
(Origin)
The type of the lead
type
is optional
Type: string
cannot be null
defined in: JsonLead
string
The location of the appraisal
dealer_location
is optional
Type: string
cannot be null
defined in: JsonLead
string
The appraised value for the vehicles
appraisal_value
is optional
Type: number
cannot be null
defined in: JsonLead
number
Task objects to associate with the appraisal
tasks
object[]
(Task)
Offer objects to associate with the sale
offers
object[]
(Offer)
Appointment objects to associate with the appraisal
appointments
is optional
Type: object[]
(Appointment)
cannot be null
defined in: JsonLead
object[]
(Appointment)
Comment objects to associate with the appraisal
comments
object[]
(Comment)
An array of URLs with information related to the appraisal
related_urls
is optional
Type: string[]
cannot be null
defined in: JsonLead
string[]
Custom fields for the appraisal
custom
object
(Details)
Reference this group by using
{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v2.0.0.schema.json#/definitions/vehicle"}
Property | Type | Required | Nullable | Defined by |
---|---|---|---|---|
ids | array |
Optional | cannot be null | JsonLead |
type | string |
Optional | cannot be null | JsonLead |
category | string |
Optional | cannot be null | JsonLead |
stock_number | string |
Optional | cannot be null | JsonLead |
body_style | string |
Optional | cannot be null | JsonLead |
make | string |
Optional | cannot be null | JsonLead |
model | string |
Optional | cannot be null | JsonLead |
version | string |
Optional | cannot be null | JsonLead |
year | number |
Optional | cannot be null | JsonLead |
month | number |
Optional | cannot be null | JsonLead |
prices | array |
Optional | cannot be null | JsonLead |
license_plate | string |
Optional | cannot be null | JsonLead |
mileage | number |
Optional | cannot be null | JsonLead |
doors | number |
Optional | cannot be null | JsonLead |
seats | number |
Optional | cannot be null | JsonLead |
warranty_months | number |
Optional | cannot be null | JsonLead |
vin | string |
Optional | cannot be null | JsonLead |
fuel | string |
Optional | cannot be null | JsonLead |
transmission | string |
Optional | cannot be null | JsonLead |
horsepower | number |
Optional | cannot be null | JsonLead |
colors | array |
Optional | cannot be null | JsonLead |
urls | array |
Optional | cannot be null | JsonLead |
dealer_location | string |
Optional | cannot be null | JsonLead |
media | array |
Optional | cannot be null | JsonLead |
engine_size | number |
Optional | cannot be null | JsonLead |
equipment | array |
Optional | cannot be null | JsonLead |
custom | object |
Optional | cannot be null | JsonLead |
A list of unique identifiers from your -and/or third party- databases or systems. This ID can be used by lead managers to corss-reference and update customer information
ids
is optional
Type: string[]
cannot be null
defined in: JsonLead
string[]
Type
type
is optional
Type: string
cannot be null
defined in: JsonLead
string
enum: the value of this property must be equal to one of the following values:
Value | Explanation |
---|---|
"new" |
|
"used" |
The vehicle category
category
is optional
Type: string
cannot be null
defined in: JsonLead
string
enum: the value of this property must be equal to one of the following values:
Value | Explanation |
---|---|
"car" |
|
"motorcycle" |
|
"industrial" |
Vehicle's human readable or friendly unique identifier from the Dealer Archives
stock_number
is optional
Type: string
cannot be null
defined in: JsonLead
string
Body style
body_style
is optional
Type: string
cannot be null
defined in: JsonLead
string
Make
make
is optional
Type: string
cannot be null
defined in: JsonLead
string
Model
model
is optional
Type: string
cannot be null
defined in: JsonLead
string
version
is optional
Type: string
cannot be null
defined in: JsonLead
string
Year manufactured
year
is optional
Type: number
cannot be null
defined in: JsonLead
number
minimum: the value of this number must greater than or equal to: 0
Month Manufactured
month
is optional
Type: number
cannot be null
defined in: JsonLead
number
minimum: the value of this number must greater than or equal to: 0
Vehicle prices
prices
object[]
(Details)
License place
license_plate
is optional
Type: string
cannot be null
defined in: JsonLead
string
Mileage
mileage
is optional
Type: number
cannot be null
defined in: JsonLead
number
minimum: the value of this number must greater than or equal to: 0
Number of doors
doors
is optional
Type: number
cannot be null
defined in: JsonLead
number
minimum: the value of this number must greater than or equal to: 0
Number of seats
seats
is optional
Type: number
cannot be null
defined in: JsonLead
number
minimum: the value of this number must greater than or equal to: 0
Duration of the warranty in months
warranty_months
is optional
Type: number
cannot be null
defined in: JsonLead
number
minimum: the value of this number must greater than or equal to: 0
Vehicle Identification Number
vin
is optional
Type: string
cannot be null
defined in: JsonLead
string
Fuel Type
fuel
is optional
Type: string
cannot be null
defined in: JsonLead
string
Transmission Type
transmission
is optional
Type: string
cannot be null
defined in: JsonLead
string
Horsepower (HP, CV)
horsepower
is optional
Type: number
cannot be null
defined in: JsonLead
number
minimum: the value of this number must greater than or equal to: 0
Colors of the vehicle
colors
object[]
(Details)
Vehicle detail page URLS
urls
is optional
Type: string[]
cannot be null
defined in: JsonLead
string[]
The location of the vehicle
dealer_location
is optional
Type: string
cannot be null
defined in: JsonLead
string
Vehicle media (Photos, Videos, 3D Models, etc)
media
object[]
(Details)
Engine volume (cc3)
engine_size
is optional
Type: number
cannot be null
defined in: JsonLead
number
Vehicle equipment
equipment
object[]
(Details)
Custom fields for the vehicle
custom
object
(Details)
Reference this group by using
{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v2.0.0.schema.json#/definitions/origin"}
Property | Type | Required | Nullable | Defined by |
---|---|---|---|---|
source | string |
Optional | cannot be null | JsonLead |
medium | string |
Optional | cannot be null | JsonLead |
campaign | string |
Optional | cannot be null | JsonLead |
The source of the lead
source
is optional
Type: string
cannot be null
defined in: JsonLead
string
The medium of the lead
medium
is optional
Type: string
cannot be null
defined in: JsonLead
string
The campaign of the lead
campaign
is optional
Type: string
cannot be null
defined in: JsonLead
string
Reference this group by using
{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v2.0.0.schema.json#/definitions/task"}
Property | Type | Required | Nullable | Defined by |
---|---|---|---|---|
ids | array |
Optional | cannot be null | JsonLead |
created_at | string |
Optional | cannot be null | JsonLead |
due_date | string |
Optional | cannot be null | JsonLead |
assigned_to | string |
Optional | cannot be null | JsonLead |
description | string |
Optional | cannot be null | JsonLead |
custom | object |
Optional | cannot be null | JsonLead |
A list of unique identifiers that originates from an external database or system. It is meant to cross-reference the task on the destination database with the external system.
ids
is optional
Type: string[]
cannot be null
defined in: JsonLead
string[]
The creation date of the task. Should follow ISO 8601 (2024-02-06T15:26:17.683Z)
created_at
is optional
Type: string
cannot be null
defined in: JsonLead
string
date time: the string must be a date time string, according to RFC 3339, section 5.6
The due date of the task. Should follow ISO 8601 (2024-02-06T15:26:17.683Z)
due_date
is optional
Type: string
cannot be null
defined in: JsonLead
string
date time: the string must be a date time string, according to RFC 3339, section 5.6
The user assigned to this task
assigned_to
is optional
Type: string
cannot be null
defined in: JsonLead
string
The task description
description
is optional
Type: string
cannot be null
defined in: JsonLead
string
Custom fields for the task
custom
object
(Details)
Reference this group by using
{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v2.0.0.schema.json#/definitions/offer"}
Property | Type | Required | Nullable | Defined by |
---|---|---|---|---|
ids | array |
Optional | cannot be null | JsonLead |
amount | number |
Optional | cannot be null | JsonLead |
description | string |
Optional | cannot be null | JsonLead |
created_at | string |
Optional | cannot be null | JsonLead |
custom | object |
Optional | cannot be null | JsonLead |
A list of unique identifiers that originates from an external database or system. It is meant to cross-reference the offer on the destination database with the external system.
ids
is optional
Type: string[]
cannot be null
defined in: JsonLead
string[]
The offered amount, in the local currency
amount
is optional
Type: number
cannot be null
defined in: JsonLead
number
The description of the offer
description
is optional
Type: string
cannot be null
defined in: JsonLead
string
The creation date of the offer. Should follow ISO 8601 (2024-02-06T15:26:17.683Z)
created_at
is optional
Type: string
cannot be null
defined in: JsonLead
string
date time: the string must be a date time string, according to RFC 3339, section 5.6
Custom fields for the offer
custom
object
(Details)
Reference this group by using
{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v2.0.0.schema.json#/definitions/appointment"}
Property | Type | Required | Nullable | Defined by |
---|---|---|---|---|
ids | array |
Optional | cannot be null | JsonLead |
created_at | string |
Optional | cannot be null | JsonLead |
start_date | string |
Optional | cannot be null | JsonLead |
end_date | string |
Optional | cannot be null | JsonLead |
assigned_to | string |
Optional | cannot be null | JsonLead |
custom | object |
Optional | cannot be null | JsonLead |
A list of unique identifiers that originates from an external database or system. It is meant to cross-reference the appointment on the destination database with the external system.
ids
is optional
Type: string[]
cannot be null
defined in: JsonLead
string[]
The creation date of the appointment. Should follow ISO 8601 (2024-02-06T15:26:17.683Z)
created_at
is optional
Type: string
cannot be null
defined in: JsonLead
string
date time: the string must be a date time string, according to RFC 3339, section 5.6
The start date of the appointment. Should follow ISO 8601 (2024-02-06T15:26:17.683Z)
start_date
is optional
Type: string
cannot be null
defined in: JsonLead
string
date time: the string must be a date time string, according to RFC 3339, section 5.6
The end date of the appointment. Should follow ISO 8601 (2024-02-06T15:26:17.683Z)
end_date
is optional
Type: string
cannot be null
defined in: JsonLead
string
date time: the string must be a date time string, according to RFC 3339, section 5.6
The user assigned to the appointment
assigned_to
is optional
Type: string
cannot be null
defined in: JsonLead
string
Custom fields for the appointment
custom
object
(Details)
Reference this group by using
{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v2.0.0.schema.json#/definitions/comment"}
Property | Type | Required | Nullable | Defined by |
---|---|---|---|---|
ids | array |
Optional | cannot be null | JsonLead |
created_at | string |
Optional | cannot be null | JsonLead |
content | string |
Optional | cannot be null | JsonLead |
custom | object |
Optional | cannot be null | JsonLead |
A list of unique identifiers that originates from an external database or system. It is meant to cross-reference the comment on the destination database with the external system.
ids
is optional
Type: string[]
cannot be null
defined in: JsonLead
string[]
The creation date of the comment. Should follow ISO 8601 (2024-02-06T15:26:17.683Z)
created_at
is optional
Type: string
cannot be null
defined in: JsonLead
string
date time: the string must be a date time string, according to RFC 3339, section 5.6
Content of the comment
content
is optional
Type: string
cannot be null
defined in: JsonLead
string
Custom fields for the comment
custom
object
(Details)
Reference this group by using
{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v2.0.0.schema.json#/definitions/price"}
Property | Type | Required | Nullable | Defined by |
---|---|---|---|---|
type | string |
Optional | cannot be null | JsonLead |
amount | number |
Optional | cannot be null | JsonLead |
currency | string |
Optional | cannot be null | JsonLead |
The type of the price
type
is optional
Type: string
cannot be null
defined in: JsonLead
string
enum: the value of this property must be equal to one of the following values:
Value | Explanation |
---|---|
"retail" |
|
"wholesale" |
|
"msrp" |
|
"export" |
The price amount
amount
is optional
Type: number
cannot be null
defined in: JsonLead
number
The currency of the price (ISO 4217)
currency
is optional
Type: string
cannot be null
defined in: JsonLead
string