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

Transaction

NameTypeRequiredDescription
product_idstringyesProvided by ABS
makestringyesThe make or brand of the tire
modelstringyesThe model of the tire
sizestringyesThe size of the tire
treadDepthnumberyesThe tread depth of the tire in thirty seconds of an inch; decimals are allowed
dateISO 8601 date stringyesThe date and time tires were sold in UTC
unitPricenumberyesThe wholesale price of one tire
quantitynumberyesThe number of tires sold in this transaction
isTrailerbooleannoOptional - set to true if tire is a trailer tire; defaults to false
partNumberstringnoOptional, Recommended - A unique part number for this tire
dotstringnoOptional, Partial DOT is allowed - The DOT number for the tire

Create Shop

NameTypeRequiredDescription
product_idstringyesProvided by ABS
placeIdstringyesGoogle Maps Place ID for the Shop
uniqueIdstringyesA unique account number or ID in your database for this Shop
legalNamestringyesThe legal name of the Shop
startDateISO 8601 date stringyesThe date that the Shop started on the program
dbastringnoThe DBA of the Shop (typically their name on Google Maps)
groupNamestringnoIf multiple enrolled Shops have common ownership and share inventory, a unique group name can be used to link the Shops together
phoneE.164 phone stringnoThe Shop's phone number
addressaddress objectnoThe Shop's physical address
mailingAttnstringnoThe attention line when sending mail to the Shop
mailingAddressaddress objectnoThe Shop's mailing address if different from their physical address
paymentPreferencecheck or creditCardnoThe Shop's payment preference - check by mail or credit card by phone
emailstring or array of stringsnoOne or more email addresses to associate with this shop for MyABS access

Update Shop

NameTypeRequiredDescription
product_idstringyesProvided by ABS
startDateISO 8601 date stringnoThe date that the Shop started on the program
endDateISO 8601 date stringnoThe date that the Shop ended the program
emailstring or array of stringsnoOne or more email addresses to associate with this shop for MyABS access

Parts

NameTypeRequiredDescription
product_idstringyesProvided by ABS
partNumberstringyesA part number unique to this tire
makestringyesThe make of the tire
modelstringyesThe model of the tire
sizestringyesThe size of the tire
dateISO 8601 date stringyesThe date of this part transaction
quantitynumberyesThe number of tires in this transaction
costnumberyesThe unit cost per tire of the tires in this transaction