Registrations

danger

This version of the API has been deprecated and is no longer supported.

Sale of a tire that is registered with a warranty.

tip

• TiresCovered is the original number of Tires Covered from the Registration
• DOT is the Department of Transportation Serial Number for the given tire
• TireClaimCount is the total claimed so far

warning

Only send in one registration per invoice. If you sell more than one of the same tire, use TireCount and the DOT1, DOT2 etc fields. Resending the same ShopID and InvoiceNumber will update the registration, not add a new one.

Field Name	Field Desc	Data Type	Required	Notes
OrgID	Organization ID	string (50)	N	Optional field for grouping things like ownership groups. Will be blank if not passed in
ShopID	Dealer/Store/Shop ID	string(25)	Y	Shop where the tires were sold
InvoiceNumber	Invoice Number	string(50)	Y	Invoice for the registration
PlanEnrollDate	Plan Enroll Date	datetime	Y	Date of enrollment
EmployeeID	Employee ID	string(50)	Y	To track individual responsible for TPP sale
CustomerID	Customer ID	String(50)	Y	Enables data to be filtered by individual customer (could be customer name or customer id number)
VehicleYear	Vehicle Year	string(25)		Four-digit year
VehicleMake	Vehicle Make	string(25)
VehicleModel	Vehicle Model	string(25)
VIN	VIN	string(50)		If available
CurrentMileage	Current Vehicle Mileage	int		Mileage at time of TPP registration/sale
TiresCovered	Count of Tires Covered	int	Y	How many tires are covered on this registration
TPPPrice	TPP Price	money	Y	TPP Price Per Tire
TireBrand	Tire Make/Brand	string(25)	Y	For all tire sales with an attached TPP
TireModel	Tire Model	string(25)
TireSize	Tire Size	string(25)	Y
TirePrice	Tire Retail Price	money	Y	Tire Retail Price Per Tire
TireCost	Tire Wholesale Price	money	Y	Tire Wholesale Cost Per Tire
TireDOT1	TireDOT1	string(25)	Y	For all tire sales with an attached TPP / if available
TireDOT2	TireDOT2	string(25)
TireDOT3	TireDOT3	string(25)
TireDOT4	TireDOT4	string(25)
TireDOT5	TireDOT5	string(25)
TireDOT6	TireDOT6	string(25)
CommercialVehicle	Commercial Vehicle	string(5)		Yes or No (Default is No)

Get Registrations

GET https://data.absintegrations.com/v2/partners/{company_name}?rec=registrations

Use query parameters to search and retrieve registrations created with us.

Example

curl --location --request GET https://data.absintegrations.com/v2/partners/{company_name}?rec=registrations&partnerid={partner_id}&shopid={shop_id}&invoicenumber={invoice_number} \
--header 'content-type: application/json' \
--header 'Authorization: Bearer {JWT}'

The above command returns JSON structured like this:

{
  "PartnerID": 1001,
  "OrgID": "",
  "ShopID": "005108",
  "InvoiceNumber": "104252",
  "PlanEnrollDate": "2018-12-04T00:00:00Z",
  "EmployeeID": "JP006",
  "CustomerID": "5108-491514",
  "VehicleYear": "08",
  "VehicleMake": "LEXUS",
  "VehicleModel": "IS 250",
  "VIN": "JTHBK262X82078324",
  "CurrentMileage": 175920,
  "TiresCovered": 2,
  "TPPPrice": 322.18,
  "TireBrand": "SUM",
  "TireModel": "225/40R18/XL 92W SUMITOMO HTR A/S P02",
  "TireSize": "2254018",
  "TirePrice": 104.98,
  "TireCost": 74.01,
  "TireDOT1": "",
  "TireDOT2": "",
  "TireDOT3": "",
  "TireDOT4": "",
  "TireDOT5": "",
  "TireDOT6": "",
  "CommercialVehicle": "false"
}

Create Registrations

POST https://data.absintegrations.com/v2/partners/{company_name}

Use this endpoint to create one or more new registrations with ABS.

Example

curl --request POST \
--url https://data.absintegrations.com/v2/partners/{company_name} \
--header 'authorization: Bearer eyJhb...SQj6A' \
--header 'content-type: application/json' \
--data {
"Registrations": [
{
"ShopID": "005308",
"InvoiceNumber": "1044273",
"PlanEnrollDate": "2018-12-04",
"EmployeeID": "JP0078",
"CustomerID": "5108-460340",
"VehicleYear": "08",
"VehicleMake": "GMC TRUCK",
"VehicleModel": "SIERRA 1500 PICKUP",
"VIN": "2GTEC19C481101249",
"CurrentMileage": "187437",
"TiresCovered": 4,
"TPPPrice": 995.68,
"TireBrand": "NIT",
"TireModel": "P265/65R18 112T NITTO CROSSTEK 2",
"TireSize": "2656518",
"TirePrice": 188.99,
"TireCost": 105.98,
"TireDOT1": "DOT 73C2 KLH0913",
"CommercialVehicle": "false"
}]}

Get Registration Status

Each registration will have a status associated with it.

Possible values for WarrantyStatus

1. Registration is Active
2. Registration is Cancelled
3. No Tires left on Registration
4. Registration is Expired

tip

• TiresCovered is the original number of Tires Covered from the Registration
• TireClaimCount is the total claimed so far
• TireCancelCount is the total cancelled so far
• TiresLeft is the number left on the registration

GET https://data.absintegrations.com/v2/partners/{company_name}?rec=registrationstatus

This is a special call to check on the status of a registration, call it just like GET Registration but it also returns the current status and number of tires left on the registration.

Example

curl --location --request GET https://data.absintegrations.com/v2/partners/{company_name}?rec=registrationstatus&partnerid={partnerid}&ShopID={shop_id}&InvoiceNumber={invoice_number} \
--header 'content-type: application/json' \
--header 'Authorization: Bearer {JWT}'

The above returns JSON structured like this

{
  "RegistrationID": 70,
  "PartnerID": 1001,
  "OrgID": "",
  "ShopID": "005108",
  "InvoiceNumber": "104252",
  "PlanEnrollDate": "2018-12-04T00:00:00Z",
  "CreatedDate": "2018-11-04T00:00:00Z",
  "TiresCovered": 2,
  "TireClaimCount": 0,
  "TireCancelCount": 0,
  "TiresLeft": 2,
  "WarrantyStatus": 1,
  "CancelDate":,
  "ExpireDate":,
  "StatusDate":,
  "Message": "Registration is Active"
}