Table of

contents

Table of Contents

Configuration

v2 - Latest API version
v1 - Deprecated API version

...

Usage

TireConnect Search From Access
Tire Search
- ACES vehicle ID
- Tire Size
- RAW size
- Manufacturer part number
- Several part numbers
- VIN
- License plate and State

...

Quote summary for parsing

...

Supplier order summary for parsing

Configuration

Demo Credentials

API KEY:

88b97fa1ecb79698ecd2b59aceb655ef

LOCATION ID:

4250

Location Selection

This API method will allow you look up all the locations which are accessible with this API key.

We recommend providing the user with a menu to select their store. When store is selected, its ID should be stored and used during TireConnect invocation.

V2 - Latest API version

Request:

https://wl.tireconnect.ca/api/v2/location/list?key={DEALER API KEY}

...

Demo Credentials

API KEY

88b97fa1ecb79698ecd2b59aceb655ef

LOCATION ID

4250

Location Selection

This API method will allow you look up all the locations which are accessible with this API key.

We recommend providing the user with a menu to select their store. When store is selected, its ID should be stored and used during TireConnect invocation.

V2 - Latest API version

Request

https://wl.tireconnect.ca/api/v2/location/list?key={DEALER API KEY}

Response format

Code Block

{  
   "notice":"Success",
   "data":{  
      "locations":[  
         {  
            "id":xxxx,
            "name":"STORE NAME",
            "dealer_id":xxx,
            "external_id":"",
            "address_line_1":"dealer@dealer.com",
            "address_line_2":"",
            "city":"CITY",
            "country":"COUNTRY",
            "country_code":"xx",
            "province":"STATE / PROVINCE",
            "postal_code":"ZIP / POSTAL CODE",
            "phone":"xxx xxx xxxx",
            "latitude":xxx",
            ”logo”:”xxx”,
            longitude":xxx
         }
      ]
   }
}

Example

...

Code Block

{  
   "notice":"Success",
   "data":{  
      "locations":[  
         {  
            "id":4250,
            "name":"Location #1",
            "dealer_id":3758,
            "external_id":null,
            "address_line_1":"3903 SE 10th Pl",
            "address_line_2":"",
            "city":"Del City",
            "country":"United States",
            "country_code":"US",
            "province":"Oklahoma",
            "postal_code":"73115",
            "phone":"416 895 8685",
            "latitude":35.4553,
            ”logo”:”https:\/\/wl.tireconnect.ca\/uploads\/dealer\/cf19ecb54145f78585b33149e042e684a08c2865.png”,
            "longitude":-97.45
         }
      ]
   }
}

V1 - Deprecated API version

...

Usage

TireConnect Search Form Access

TC can be opened using the dealer specific URL.

URL

https://wlapp.tireconnect.ca/api/v1/location/list?key={DEALER API KEY}

Response format:

Code Block

{  
   "notice":"Success",
   "data":{  
      "locations":[  
         {  
            "id":xxxx,
            "name":"STORE NAME",
            "dealer_id":xxx,
            "external_id":"",
            "address_line_1":"dealer@dealer.com",
            "address_line_2":"",
            "city":"CITY",
            "country":"COUNTRY",
            "country_code":"xx",
            "province":"STATE / PROVINCE",
            "postal_code":"ZIP / POSTAL CODE",
            "phone":"xxx xxx xxxx",
            "latitude":            xxx"longitude":xxx
         }
      ]
   }
}

...

pos/{DEALER API KEY}f#/!search?location_id={LOCATION ID}

Example

https://app.tireconnect.ca/pos/88b97fa1ecb79698ecd2b59aceb655ef#/!search?location_id=4250

Tire Search

ACES Vehicle ID

Format

https://app.tireconnect.ca/pos/{DEALER API KEY}#/!search?aces_id={ACES ID}&location_id={LOCATION ID}

Example

https://app.tireconnect.ca/pos/88b97fa1ecb79698ecd2b59aceb655ef#/!search?aces_id=268647&location_id=4250

Tire Size

Format

https://app.tireconnect.ca/pos/{DEALER API KEY}#/!search?width={WIDTH}&height={HEIGHT}&rim={RIM}&location_id={LOCATION ID}

Example

https://app.tireconnect.ca/pos/88b97fa1ecb79698ecd2b59aceb655ef#/!search?width=205&height=55&rim=16&location_id=4250

RAW Size

Format

https://app.tireconnect.ca/pos/{DEALER API KEY}#/!search?size={RAW_SIZE}&location_id={LOCATION ID}

Example

https://app.tireconnect.ca/pos/88b97fa1ecb79698ecd2b59aceb655ef#/!search?size=2055516&location_id=4250

Manufacturer Part Number

Format

https://app.tireconnect.ca/pos/{DEALER API KEY}#/!search?part_numbers={PART NUMBER}&location_id={LOCATION ID}

Note: method accept several part numbers comma separated.

Example

Single part number: https://app.tireconnect.ca/pos/88b97fa1ecb79698ecd2b59aceb655ef#/!search?part_numbers=148895&location_id=4250

Several part numbers:

https://app.tireconnect.ca/pos/88b97fa1ecb79698ecd2b59aceb655ef#/!search?part_numbers=000240,011969&location_id=4250

VIN

Format

https://app.tireconnect.ca/pos/{DEALER API KEY}#/!search?vin={VIN}&location_id={LOCATION ID}

Example

https://app.tireconnect.ca/pos/88b97fa1ecb79698ecd2b59aceb655ef#/!search?vin=4S3BNEN6XH3058857&location_id=4250

Licence Plate and State (USA only)

Format

https://app.tireconnect.ca/pos/{DEALER API KEY}#/!search?state={State}&license={LICENSE PLATE}&location_id={LOCATION ID}

Example

https://app.tireconnect.ca/pos/88b97fa1ecb79698ecd2b59aceb655ef#/!search?state=SD&license=12345&location_id=4250

Quote summary for parsing

JSON quote summary is generated in hidden DIV with id “tcwlw_raw_quote” on the summary page.

Quote data extraction

There are two conditions required for successful quote data extraction:

DIV with this id is detected, you can extract the content of the quote from the JSON formatted quote summary.
ready=1 - READY URL parameter is equal 1

URL Example

https://app.tireconnect.ca/pos/88b97fa1ecb79698ecd2b59aceb655ef#/!summary?location_id=4250&tire_id=QnJpZGdlc3RvbmV8fDExNjgzM3x8TEktT0tUfHw0MjUwfHxC&quantity=1&ready=1

JSON Example

Code Block
{ "tires": [ { "id": "TWlsZXN0YXJ8fDI0NDYwMDIxfHxjb21tdW5pdHl3aG9sZXNhbGV0aXJlfHwyMjU5Mnx8Qg==", "brand": "Milestar", "

province

model": "

Oklahoma

MS932 Sport",

postal

part_

code

number": "

73115

24460021",
      "price": 59.96,
      "

phone

tax":

"416 895 8685",

 2.4,
      "quantity": 153,
      "image"

latitude

: "

:35.4553

https://wl.tireconnect.ca/uploads/tires/pre_up/1/Milestar/images/ms_ms932_l.jpg",
      "supplier": "communitywholesaletire",
      "

longitude

speed_rating":

-97.45

 "V",
      "load_index": 91,

}

]

"size": "205/55R16 91V",

} }

Usage

TireConnect Search Form Access

TC can be opened using the dealer specific URL.

URL:

https://app.tireconnect.ca/pos/{DEALER API KEY}f#/!search?location_id={LOCATION ID}

Example:

https://app.tireconnect.ca/pos/88b97fa1ecb79698ecd2b59aceb655ef#/!search?location_id=4250

Tire Search

ACES Vehicle ID

Format

https://app.tireconnect.ca/pos/{DEALER API KEY}#/!search?aces_id={ACES ID}&location_id={LOCATION ID}

Example

https://app.tireconnect.ca/pos/88b97fa1ecb79698ecd2b59aceb655ef#/!search?aces_id=268647&location_id=4250

Tire Size

Format

https://app.tireconnect.ca/pos/{DEALER API KEY}#/!search?width={WIDTH}&height={HEIGHT}&rim={RIM}&location_id={LOCATION ID}

Example

https://app.tireconnect.ca/pos/88b97fa1ecb79698ecd2b59aceb655ef#/!search?width=205&height=55&rim=16&location_id=4250

RAW Size

Format

https://app.tireconnect.ca/pos/{DEALER API KEY}#/!search?size={RAW_SIZE}&location_id={LOCATION ID}

Example

https://app.tireconnect.ca/pos/88b97fa1ecb79698ecd2b59aceb655ef#/!search?size=2055516&location_id=4250

Manufacturer Part Number

Format

https://app.tireconnect.ca/pos/{DEALER API KEY}#/!search?part_numbers={PART NUMBER}&location_id={LOCATION ID}

* Note: method accept several part numbers comma separated.

Example

Single part number: https://app.tireconnect.ca/pos/88b97fa1ecb79698ecd2b59aceb655ef#/!search?part_numbers=148895&location_id=4250

...

https://app.tireconnect.ca/pos/88b97fa1ecb79698ecd2b59aceb655ef#/!search?part_numbers=000240,011969&location_id=4250

VIN

Format

https://app.tireconnect.ca/pos/{DEALER API KEY}#/!search?vin={VIN}&location_id={LOCATION ID}

Example

https://app.tireconnect.ca/pos/88b97fa1ecb79698ecd2b59aceb655ef#/!search?vin=4S3BNEN6XH3058857&location_id=4250

...

Format

https://app.tireconnect.ca/pos/{DEALER API KEY}#/!search?state={State}&license={LICENSE PLATE}&location_id={LOCATION ID}

Example

https://app.tireconnect.ca/pos/88b97fa1ecb79698ecd2b59aceb655ef#/!search?state=SD&license=12345&location_id=4250

Quote summary for parsing

JSON quote summary is generated in hidden DIV with id “tcwlw_raw_quote” on the summary page.

Quote data extraction:

There are two conditions required for successful quote data extraction:

DIV with this id is detected, you can extract the content of the quote from the JSON formatted quote summary.
ready=1 - READY URL parameter is equal 1

URL Example

https://app.tireconnect.ca/pos/88b97fa1ecb79698ecd2b59aceb655ef#/!summary?location_id=4250&tire_id=QnJpZGdlc3RvbmV8fDExNjgzM3x8TEktT0tUfHw0MjUwfHxC&quantity=1&ready=1

JSON Example

Code Block{ "tires": [ { "brand": "Bridgestone", "model": "Turanza EL42", "part_number": "116833", "price": 370.99, "tax": 16.69, "quantity": 10

"size_w": 205,
      "size_h": 55,
      "size_r": 16,
      "selected_quantity": 4,
      "cost": 41.97
    }
  ],
  "services": [
    {
      "key": "tire_protection_plan",
      "name": "Tire Protection Plan",
      "total_price": 10,
      "total_tax": 0.4
    },
    {
      "key": "wheel_alignment",
      "name": "Wheel Alignment",
      "total_price": 23.98,
      "total_tax": 0.96
    },
    {
      "key": "nitrogen_fill",
      "name": "Nitrogen Fill",
      "total_price": 100,
      "total_tax": 4
    },
    {
      "key": "disposal_fee",
      "name": "Tire Recycling Fee",
      "total_price": 10,
      "total_tax": 0
    },
    {
      "key": "supply_fee",
      "name": "Shop Supply Fee",
      "total_price": 50,
      "total_tax": 0
    },
    {
      "key": "seasonal_tire_storage",
      "name": "Seasonal Tire Storage",
      "total_price": 24,
      "total_tax": 0.96
    },
    {
      "key": "valve_stem_tpms",
      "name": "Valve Stem or TPMS Part Kit",
      "total_price": 100,
      "total_tax": 4
    }
  ],
  "vehicle": {
    "year": "2020",
    "make": "Alfa Romeo",
    "model": "4C",
    "trim": "Spider",
    "car_tire_id": "163508||163509"
  }
}

Option 2 - By listening to widget events

This method can be used both with direct embedding of the TC module on the page, as well as an iframe based integration. The difference would be that when iframe is used, a container page needs to be created. This page will actually contain the widget and the event listener. The event listener function will need to pass the data captured in the event to the parent page.

Documentation

TC Widget Callbacks

Example

https://tutorials.tireconnect.ca/pos_demo/pos_container.html

Supplier order summary for parsing

JSON quote summary is generated in hidden DIV with id “tcwlw_pos_supplier_order_submitted” on results or summary page.

Quote data extraction:

There are two conditions required for successful quote data extraction:

DIV with this id is detected, you can extract the content of the quote from the JSON formatted quote summary.
supplier_order_submitted=1 - READY URL parameter is equal 1

URL Examples (PIN for both 416905)

Results page:

https://tutorials.tireconnect.ca/demo/pos_callback.html#!results?size=2055516&order_by=best_match&display=full&location_id=22592&min_quantity=1&page=1

Summary page:

https://tutorials.tireconnect.ca/demo/pos_callback.html#!summary?location_id=22592&vehicle[year]=2009&vehicle[make]=Aston Martin&vehicle[model]=V8 Vantage&vehicle[trim]=(22mm hex lug nut)&vehicle[car_tire_id]=93137||93139&optional_services=use_default&quantities[0]=4&tire_ids[0]=QnJpZGdlc3RvbmV8fDEyMzU2NXx8Y29tbXVuaXR5d2hvbGVzYWxldGlyZXx8MjI1OTJ8fEI%3D&ready=1

JSON Example

Code Block
{ "branches_status": [ { "branch_name": "common", "

image

status": "

https://wl.tireconnect.ca/uploads/tires/pre_up/Bridgestone/images/bs_turanza_el42_l.jpg

success",
      "

supplier

invoice": "

LI-OKT",

speed

order_

rating":

info": {
    "

H

cost": 45,

load_index

quantity":

91

1,

size

total_cost":

"205/55R16 91H"

45,

size

shipping_

w

cost":

205

null,

size

total_

h

order":

55,

},
  "

size

supplier_order_

r

fields":

16,

selected

delivery_

quantity

method":

1

"Pickup",

cost

po_number":

123.99

"TEST PO"
  }

]

,
  "

services

supplier":

[

{

"name": "km",
    "

key

nice_name": "

installation

K&M"

,

},
  "

name

tire":

"Install

+

Balance"

} ] } </div>

Supplier order summary for parsing

JSON quote summary is generated in hidden DIV with id “tcwlw_pos_supplier_order_submitted” on results or summary page.

...

There are two conditions required for successful quote data extraction:

DIV with this id is detected, you can extract the content of the quote from the JSON formatted quote summary.
supplier_order_submitted=1 - READY URL parameter is equal 1

URL Examples (PIN for both 555555)

Results page:

https://devapp.tireconnect.ca/pos/05198c64d142efd851ef15e54fdd917d#/!results?size=2055516&location_id=12674&order_by=best_match&display=full&page=1

Summary page:

https://devapp.tireconnect.ca/pos/05198c64d142efd851ef15e54fdd917d#/!summary?location_id=12674&optional_services=use_default&quantities%5B0%5D=4&tire_ids%5B0%5D=SGFua29va3x8MTAxNDM1OHx8a218fDEyNjc0fHxC

JSON Example

Code Block{ "branches_status": [ { "branch_name": "common",

"brand": "GT Radial",
    "model": "Champiro Touring A/S",
    "part_number": "B508",
    "size_h": 55,
    "size_r": 16,
    "size_w": 205,
    "size": "205/55R16 91H",
    "size_type": "Eurometric",
    "tire_type": "Passenger",
    "load_range": null,
    "image": "https://wl.tireconnect.ca/uploads/tires/pre_up/1/GT_Radial/images/gt_champiro_touring_as_l.jpg",
    "category": {
      "

status

id":

"success"

20,
      "

invoice

value": "

999999999

Touring"

}

], "order_info

"label":

{

"Touring All Season"

"cost":

43

},
    "

quantity

season":

1,

{
      "

total_cost

id":

43, "shipping_cost": null,

2,
      "

total_order

value": "All Season"

43

   },
    "supplier_

order_fields

details": {
      "

delivery_method

id": "

Deliver

km",
      "

po_number

name": "K&M"

Test

PO"

},

supplier

stock": [
        {

"name":

"KM",

nice_name

branch": "

K&M

Primary",

},

"tire": {

brand

quantity":

"Thunderer",

"model":

"Mach

II

R301"

},

"part_number": "TH0090",

"size_h":

55,

size_r

branch":

16

"Alternate",

"size_w":

205,

size

quantity":

"205/55R16 91V",

"image": "https://dev.tireconnect.ca/uploads/tires/pre_up/Thunderer/images/th_mach_ii_r301_l.jpg", "category": "Performance

   },
        {
          "branch": "National",

"season

      "quantity":

"All Season"

Version	Old Version 2	New Version Current
Changes made by	Oleksii Pashuta	George Silagadze
Saved on	Feb 24, 2020	Oct 11, 2023

Content Comparison

Versions Compared

Key

Configuration

Configuration

Demo Credentials

API KEY:

LOCATION ID:

Location Selection

V2 - Latest API version

Request:

Demo Credentials

API KEY

LOCATION ID

Location Selection

V2 - Latest API version

Request

Response format

Example

V1 - Deprecated API version

Usage

TireConnect Search Form Access

URL

Response format:

Example

Tire Search

ACES Vehicle ID

Format

Example

Tire Size

Format

Example

RAW Size

Format

Example

Manufacturer Part Number

Format

Example

VIN

Format

Example

Licence Plate and State (USA only)

Format

Example

Quote summary for parsing

Quote data extraction

URL Example

JSON Example

Usage

TireConnect Search Form Access

URL:

Example:

Tire Search

ACES Vehicle ID

Format

Example

Tire Size

Format

Example

RAW Size

Format

Example

Manufacturer Part Number

Format

Example

VIN

Format

Example

Format

Example

Quote summary for parsing

Quote data extraction:

URL Example

JSON Example

Option 2 - By listening to widget events

Documentation

Example

Supplier order summary for parsing

URL Examples (PIN for both 416905)

JSON Example