Cancellations
danger
This version of the API has been deprecated and is no longer supported.
Cancellation of an existing warranty.
warning
To accommodate retransmissions any cancellation with identical OrgID, ShopID, InvoiceNumber, CancelShopID and CancelInvoiceNumber will be treated as an update, not a new cancellation.
| Field Name | Field Desc | Data Type | Required | Notes |
|---|---|---|---|---|
OrgID | Organization ID | string (50) | N | Optional field for grouping. For example ownership group. Blank if not passed in |
ShopID | Dealer/Store/Shop ID | string(25) | Y | Shop ID from original sale and registration |
InvoiceNumber | Sale Invoice Number | string(25) | Y | Invoice from the original sale and registration |
CancelShopID | Dealer/Store/Shop ID | string(25) | Y | Shop ID where the tire registrations were cancelled |
CancelInvoiceNumber | Sale Invoice Number | string(25) | Y | Invoice from the the shop where tire registrations were cancelled |
TireCancelCount | Count of Tires Cancelled | int | Y | How many tires were cancelled |
CancelDate | Date Cancelled | datetime | Y | Date of the cancellation |
Get Cancellations
GET https://data.absintegrations.com/v2/partners/{company_name}?rec=cancellations
Use this endpoint to retrieve one or more cancellations
Example
curl --location --request GET https://data.absintegrations.com/v2/partners/{company_name}?rec=cancellations&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": "104283",
"CancelShopID": "005108",
"CancelInvoiceNumber": "104283",
"CancelDate": "2020-01-27T00:00:00Z"
}
Create Cancellations
POST https://data.absintegrations.com/v2/partners/{company_name}
Use this endpoint to make one or more cancellation 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 {
"Cancellations": [
{
"ShopID": "005054568",
"InvoiceNumber": "354365667",
"CancelShopID": "005054568",
"CancelInvoiceNumber": "365365167",
"TireCancelCount": "1",
"CancelDate": "2020-01-27"
}]}