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

Transaction

Name	Type	Required	Description
product_id	string	yes	Provided by ABS
make	string	yes	The make or brand of the tire
model	string	yes	The model of the tire
size	string	yes	The size of the tire
treadDepth	number	yes	The tread depth of the tire in thirty seconds of an inch; decimals are allowed
date	ISO 8601 date string	yes	The date and time tires were sold in UTC
unitPrice	number	yes	The wholesale price of one tire
quantity	number	yes	The number of tires sold in this transaction
isTrailer	boolean	no	Optional - set to true if tire is a trailer tire; defaults to false
partNumber	string	no	Optional, Recommended - A unique part number for this tire
dot	string	no	Optional, Partial DOT is allowed - The DOT number for the tire

Create Shop

Name	Type	Required	Description
product_id	string	yes	Provided by ABS
placeId	string	yes	Google Maps Place ID for the Shop
uniqueId	string	yes	A unique account number or ID in your database for this Shop
legalName	string	yes	The legal name of the Shop
startDate	ISO 8601 date string	yes	The date that the Shop started on the program
dba	string	no	The DBA of the Shop (typically their name on Google Maps)
groupName	string	no	If multiple enrolled Shops have common ownership and share inventory, a unique group name can be used to link the Shops together
phone	E.164 phone string	no	The Shop's phone number
address	address object	no	The Shop's physical address
mailingAttn	string	no	The attention line when sending mail to the Shop
mailingAddress	address object	no	The Shop's mailing address if different from their physical address
paymentPreference	check or creditCard	no	The Shop's payment preference - check by mail or credit card by phone
email	string or array of strings	no	One or more email addresses to associate with this shop for MyABS access

Update Shop

Name	Type	Required	Description
product_id	string	yes	Provided by ABS
startDate	ISO 8601 date string	no	The date that the Shop started on the program
endDate	ISO 8601 date string	no	The date that the Shop ended the program
email	string or array of strings	no	One or more email addresses to associate with this shop for MyABS access

Parts

Name	Type	Required	Description
product_id	string	yes	Provided by ABS
partNumber	string	yes	A part number unique to this tire
make	string	yes	The make of the tire
model	string	yes	The model of the tire
size	string	yes	The size of the tire
date	ISO 8601 date string	yes	The date of this part transaction
quantity	number	yes	The number of tires in this transaction
cost	number	yes	The unit cost per tire of the tires in this transaction