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

Name	Type	Required
product_id	string	yes
invoiceNumber	string	yes
enrollDate	ISO 8601 date string	yes
customer	customer	yes
tires	Array of tires	yes
vehicle	vehicle	no
comments	string	no
storeNumber	string	no

Registration Metadata

Name	Type
enrollDate	ISO 8601 date string
expirationDate	ISO 8601 date string
cancelledOnDate	ISO 8601 date string
claimedTiresCount	number
availableTiresCount	number
hasTiresToClaim	boolean
isActive	boolean

Customer

Name	Type	Required
name	string	yes
phone	E.164 phone string	yes*
email	email string	yes*
address	address object	no

* At least one of phone or email is required.

Address

Name	Type	Required	Description
line1	string	yes
line2	string	no
city	string	yes
state	string	yes
country	string	no	"US" and "CA" accepted, defaults to "US"
zip	string	yes	When country is "CA" zip can be used for postal code

Original Tire

Name	Type	Required
make	string	yes
model	string	yes
size	string	yes
retailPrice	number	yes
dot	string	no
partNumber	string	no

Vehicle

Name	Type	Required
year	4-digit number	yes
make	string	yes
model	string	yes
vin	string	no
plateNumber	string	no
plateState	string	no
mileage	number	no

Claim

Name	Type	Required
serviceInvoiceNumber	string	yes
serviceInvoiceDate	ISO 8601 date string	yes
vehicleMileage	number	yes
damageReason	Damage Reason	no
damageDescription	string	no
authorizedAmount	number	no
tires	Array<claim tire object>	yes

Damage Reasons

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

Claimed Tire

Name	Type	Required	Description
original	original tire	yes	The original registered tire that is being claimed.
replacement	replacement tire	no	The 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

Name	Type	Required
make	string	yes
model	string	yes
size	string	yes
originalTreadDepth	number	no
partNumber	string	no
retailPrice	number	no
wholesaleCost	number	no
dot	string	no