Skip to main content

Object Types

The API uses the following object types in requests and responses for the Tire Protection category.

Making a POST request without a required field will result in the error 400: Bad Request.

Registration

NameTypeRequired
product_idstringyes
invoiceNumberstringyes
enrollDateISO 8601 date stringyes
customercustomeryes
tiresArray of tiresyes
vehiclevehicleno
commentsstringno
storeNumberstringno

Registration Metadata

NameType
enrollDateISO 8601 date string
expirationDateISO 8601 date string
cancelledOnDateISO 8601 date string
claimedTiresCountnumber
availableTiresCountnumber
hasTiresToClaimboolean
isActiveboolean

Customer

NameTypeRequired
namestringyes
phoneE.164 phone stringyes*
emailemail stringyes*
addressaddress objectno

* At least one of phone or email is required.

Address

NameTypeRequiredDescription
line1stringyes
line2stringno
citystringyes
statestringyes
countrystringno"US" and "CA" accepted, defaults to "US"
zipstringyesWhen country is "CA" zip can be used for postal code

Original Tire

NameTypeRequired
makestringyes
modelstringyes
sizestringyes
retailPricenumberyes
dotstringno
partNumberstringno

Vehicle

NameTypeRequired
year4-digit numberyes
makestringyes
modelstringyes
vinstringno
plateNumberstringno
plateStatestringno
mileagenumberno

Claim

NameTypeRequired
serviceInvoiceNumberstringyes
serviceInvoiceDateISO 8601 date stringyes
vehicleMileagenumberyes
damageReasonDamage Reasonno
damageDescriptionstringno
authorizedAmountnumberno
tiresArray<claim tire object>yes

Damage Reasons

Value (string)
'Sidewall damage - puncture'
'Sidewall damage - impact'
'Main tread - puncture'
'Main tread - impact'
'Other'

Claimed Tire

NameTypeRequiredDescription
originaloriginal tireyesThe original registered tire that is being claimed.
replacementreplacement tirenoThe replacement tire that is being claimed. This field is optional. When this tire is not provided it is understood that the original tire is being repaired rather than replaced.

Replacement Tire

NameTypeRequired
makestringyes
modelstringyes
sizestringyes
originalTreadDepthnumberno
partNumberstringno
retailPricenumberno
wholesaleCostnumberno
dotstringno