Product API Information
The product API was developed to allow creation of warranty registrations by external systems without a need to login to the store.
General API usage
The endpoint URL accepts a regular POST request. The result is provided as json data. Each request will have to contain username and key parameters to identify the sender.
‘Register Product’ request
URL: https://corporders.tractag.global/product-api
Possible fields of the request are described in the table below. Most of these fields can be found on the ‘Product Registration’ page.
Field | Type | Description |
username | Required, text | Credentials from customer account |
key | Required, text | Credentials from customer account |
request-type | Required, text | Possible types: register
At the present moment, only one type is possible. |
deviceid | Required,text | DEVICE ID/MACID Number |
customer_name | Required, text | Full customer name, Ex: “John Smith” |
customer_address | Optional, text |
|
customer_city | Optional, text |
|
customer_province | Optional, text | Customer Province/State |
customer_postcode | Optional, text |
|
customer_email | Required, text |
|
customer_phone | Required, text |
|
dealer_name | Required, text |
|
vin | Optional, text | Asset Serial Number/VIN |
year | Optional, text |
|
make | Optional, text |
|
model | Optional, text |
|
product_code | Required, text | Product code. The product code can be found on a product page of the store. (Inside Opencart, it is a ‘model’ field). |
purchase_date | Required,text | Format: YYYY-MM-DD, Ex: “2021-11-23” |
locate_wakeup | Optional, text | Locate Wake Up Time |
The result of the request will be provided as json data.
The following result will be received on success.
Field | Type | Description |
result | Required,text | Value: ‘success’ |
record_id | Required, text | This field will contain a record_id assigned to the submitted product record. |
record_status | Required, text | Initially the record can get ‘pending’ or ‘approved’ status. |
The following result will be received on error.
Field | Type | Description |
result | Required,text | Value: ‘error’ |
error | Required, text | This field will contain some explanation on why the error result was returned. |
API Restrictions
There are no restrictions for API calls by a number of requests (time or amount) at the present moment.
