Claims
danger
This version of the API has been deprecated and is no longer supported.
Warranty claim made on a registered sale.
tip
TireClaimCount
is the total claimed so far
Possible values for ServiceType
REPLACE
- tire was replacedREPAIR
- tire went through a repair
warning
To accommodate retransmissions any claim with identical OrgID
, ShopID
, InvoiceNumber
, RepairShopID
and RepairInvoiceNumber
will be treated as an update, not a new claim.
Field Name | Field Desc | Data Type | Required | Notes |
---|---|---|---|---|
OrgID | Organization ID | string (50) | N | Optional field for grouping by things like ownership groups. Will be blank if not passed in |
ShopID | Dealer/Store/Shop ID | string(25) | Y | Shop where the registration was sold |
InvoiceNumber | Repair Invoice Number | string(25) | Y | Invoice Number for the original registration sale |
ClaimDate | Claim Date | datetime | Y | Date of claim |
RepairShopID | Original Store / ShopID | string(25) | Y | Shop ID where the repair was performed |
RepairInvoiceNumber | Original Invoice Number | string(50) | Y | Invoice from the repair work |
VIN | VIN | string(50) | If available | |
VehicleMileage | Vehicle Mileage at Time of Claim | int | Mileage at the time of repair | |
TireClaimCount | Count of Tires in Claim | int | Y | How many tires were repaired |
CreditAmount | Amount Credited to Customer (Total) | money | Y | Discount amount * quantity |
CostPerUnit | Amount the Claim Cost Per Unit | money | Y | Replacement cost per tire at time of repair |
TireLocation1 | Location of tire 1 on vehicle | string(200) | Ex. "front passenger" or "right front" | |
TireLocation2 | Location of tire 2 on vehicle | string(200) | ||
TireLocation3 | Location of tire 3 on vehicle | string(200) | ||
TireLocation4 | Location of tire 4 on vehicle | string(200) | ||
TireLocation5 | Location of tire 5 on vehicle | string(200) | ||
TireLocation6 | Location of tire 6 on vehicle | string(200) | ||
ServiceDescription | Service Classification / Description | string(200) | i.e., "sidewall" or "screw in tread" - incorporate dropdown into POS screen? | |
TireBrand | Replacement Tire Make/Brand | string(25) | Y | |
TireModel | Replacement Tire Model | string(25) | ||
TireSize | Replacement Tire Size | string(25) | Y | |
TireCost | Replacement Tire Price | money | Y |
Get Claims
GET https://data.absintegrations.com/v2/partners/{company_name}?rec=claims
Use this endpoint to get one or more claims
Example
curl --location --request GET https://data.absintegrations.com/v2/partners/{company_name}?rec=claims&partnerid={partnerid}&shopid={shop_id}&invoicenumber={invoice_number} \
--header 'content-type: application/json' \
--header 'Authorization: Bearer {JWT}'
The above returns JSON structured like this
{
"PartnerID": 1001,
"OrgID": "",
"ShopID": "005108",
"InvoiceNumber": "104155",
"ClaimDate": "2020-01-27T00:00:00Z",
"RepairShopID": "005108",
"RepairInvoiceNumber": "104273",
"VIN": "",
"VehicleMileage": 96192,
"TireClaimCount": 4,
"CreditAmount": 64.04,
"CostPerUnit": 60,
"ServiceType": "REPLACE",
"ServiceDescription": "",
"TireLocation1": "",
"TireLocation2": "",
"TireLocation3": "",
"TireLocation4": "",
"TireLocation5": "",
"TireLocation6": "",
"TireBrand": "SUM",
"TireModel": "235/60R18/XL 107V SUMITOMO HTR A/S P02 BLK",
"TireSize": "2356018",
"TirePrice": 0,
"TireCost": 58.94
}
Create Claims
POST https://data.absintegrations.com/v2/partners/{company_name}
Use this endpoint to create one or more new claims with ABS.
Example
curl --location --request POST https://data.absintegrations.com/v2/partners/{company_name} \
--header 'Authorization: Bearer {JWT}' \
--header 'Content-Type: application/json' \
--data-raw '{
"Claims": [{
"ShopID": "0056678",
"InvoiceNumber": "35554367",
"ClaimDate": "2020-01-27",
"ShopID": "0056698",
"InvoiceNumber": "9994498",
"VehicleMileage": 96192,
"TireClaimCount": 4,
"CreditAmount": 64.04,
"CostPerUnit": 60.00,
"ServiceType": "REPLACE",
"ServiceDescription": "FLAT REPAIR PASSENGER REAR",
"TireBrand": "SUM",
"TireModel": "235/60R18/XL 107V HTR A/S P02 BLK",
"TireSize": "2356018",
"TireCost": 58.00
}]}'