BSRO Catalog (v 1.2.1)

Owned by Oleksandr Samarin
Dec 12, 2019
52 min read

OVERVIEW

This document describes Output REST API Functions. Main API methods helps to search actual sizes of tires , search tires by vehicle,  etc.

Methods

#Api methodUrldescription
1Size width(cross)/api/sizeShow all AVAILABLE size of catalog
2Size Height(aspect)/api/size/{cross}Show all AVAILABLE size of catalog, linked to pointed cross size
3Size Rim/api/size/{cross}/{aspect}Show all AVAILABLE size of catalog, linked to pointed cross and aspect sizes
4Vehicle Years/api/by_vehicleYear dropdown. Must have only available vehicles
5Vehicles Makes by year/api/by_vehicle/{year}Make name and id dropdown. Must have only available makes by year
6Vehicles Models by year and makeid/api/by_vehicle/{year}/{makeId}Model name and id dropdown. Must have only available Model by year and makeid
7Vehicle Submodels by year, makeid and model/api/by_vehicle/{year}/{makeId}/{modelId}submodel (trim) id and name  dropdown. Must have only available Model by year,modelid and makeid
8Search tire by Size/api/search/by_sizeShow tires, that available in catalog, search by size.
9Search tire by Vehicle/api/search/by_vehicleShow tires, that available in catalog, by brand and product number.
10Search tire by tireName and brand/api/search/by_brandShow tires, that available in catalog, search by vehicle.
11Vehicle Makes List/api/vehicle/reverseShow the entire distinct vehicle makes.
12Vehicle Models List by Make/api/vehicle/reverse/{friendlyMakeName}Show the entire distinct vehicle models for a given make.
13Vehicle YearVehicle Years List by Make and Models List by Make and Model

/api/vehicle/reverse/{friendlyMakeName}/{friendlyModelName}

Show the entire distinct vehicle models for a given make and model.
14Vehicle Trims/Submodels List by Model, Make and Year/api/vehicle/reverse/{friendlyMakeName}/{friendlyModelName}/{year}Show the entire distinct vehicle models for a given make, model and year.
15Vehicle Id (ACES) by Model, Make, Year and Trim/Submodel/api/vehicle/reverse/{friendlyMakeName}/{friendlyModelName}/{year}/{friendlySubmodelName}Show the unique Aces vehicle ID for a given year, make and model and submodel friendly names.
16Size Rims List/api/size/reverseShow the entire distinct vehicle rim diameter values.
17Size Cross and Aspect List By Rim/api/size/reverse/{rimSize}Show the entire distinct tire sizes for the given vehicle rim diameter value by size.
18Vehicle Fitment Details/api/vehicle/fitment/{acesVehicleId}Show vehicle fitment details  for the given Aces Vehicle Id.
19Tires by Category/api/tire/category/{category}Show tire models by category.
20Vehicles by Category/api/vehicle/category/{category}Show vehicle make and model list by vehicle type.

Size dictionary must help to know actual sizes from database; it must return known sizes linked one to other;

Search must return known tires, used brand & part number;

Search by size must return size id & founded tires;


METHODS DESCRIPTION


1. Size Widths (Cross Sections)

Explanation:

Show all available Cross sizes for drop down list.

Action: GET

URL: https://bsro.tireconnect.ca/api/size

EG. https://bsro.tireconnect.ca/api/size

Output 
{
  "statusCode": "SUCCESSFUL",
  "payload": {
    "cross": [
      {
        "value": "155",
        "text": "155"
      },
      {
        "value": "165",
        "text": "165"
      },
      {
        "value": "175",
        "text": "175"
      },
      {
        "value": "185",
        "text": "185"
      },
      {
        "value": "195",
        "text": "195"
      },
      {
        "value": "205",
        "text": "205"
      },
      {
        "value": "215",
        "text": "215"
      },
      {
        "value": "225",
        "text": "225"
      },
      {
        "value": "235",
        "text": "235"
      },
      {
        "value": "245",
        "text": "245"
      },
      {
        "value": "255",
        "text": "255"
      },
      {
        "value": "265",
        "text": "265"
      },
      {
        "value": "275",
        "text": "275"
      },
      {
        "value": "285",
        "text": "285"
      },
      {
        "value": "295",
        "text": "295"
      },
      {
        "value": "305",
        "text": "305"
      },
      {
        "value": "315",
        "text": "315"
      },
      {
        "value": "325",
        "text": "325"
      },
      {
        "value": "30",
        "text": "30"
      },
      {
        "value": "31",
        "text": "31"
      },
      {
        "value": "32",
        "text": "32"
      },
      {
        "value": "33",
        "text": "33"
      },
      {
        "value": "35",
        "text": "35"
      },
      {
        "value": "37",
        "text": "37"
      }
    ]
  }
}

Output description

valuepathcomment
statusCoderoot.statusCode=SUCCESSFUL
payloadroot.payloadNODE
crossroot.payload.crossNODE
valueroot.payload.cross[].valueThis is an integer value represented as string. 9.5 will be 950
textroot.payload.cross[].textThis is a text value. Something, that may be shown in dropdownlistbox.

Note:

 All data actual for our catalog. For example if we do not have any tire with 155 cross size we won’t show it. Output sorted by text.



2. Size Heights (Aspect Ratios)

Explanation:

Show all available Aspect sizes for drop down list.

Action: GET

URL: https://bsro.tireconnect.ca/api/size/cross

EG. https://bsro.tireconnect.ca/api/size/215

Request Parameters

Parameter(s)example value and explanation if neededRequired
cross215 (Cross Section).  inputYES
Output 
{
  "statusCode": "SUCCESSFUL",
  "payload": {
    "aspect": [
      {
        "value": "35",
        "text": "35"
      },
      {
        "value": "40",
        "text": "40"
      },
      {
        "value": "45",
        "text": "45"
      },
      {
        "value": "50",
        "text": "50"
      },
      {
        "value": "55",
        "text": "55"
      },
      {
        "value": "60",
        "text": "60"
      },
      {
        "value": "65",
        "text": "65"
      },
      {
        "value": "70",
        "text": "70"
      },
      {
        "value": "75",
        "text": "75"
      },
      {
        "value": "85",
        "text": "85"
      }
    ]
  }
}

Output description

valuepathcomment
statusCoderoot.statusCode=SUCCESSFUL
payloadroot.payloadNODE
aspectroot.payload.aspectNODE
valueroot.payload.aspect[].valueThis is an integer value represented as string. 9.5 will be 950
textroot.payload.aspect[].textThis is a text value. Something, that may be shown in dropdownlistbox.

Note:

All data actual for our catalog. For example if we do not have any tire with 70 aspect size we won’t show it.

Exception:

if nothing found : {"statusCode":"VALIDATION_ERROR","message":"Sorry, there is no information available on the requested product."}

3. Size Rims

Explanation:

To show all available Rims sizes for drop down list.

Action: GET

URL: https://bsro.tireconnect.ca/api/size/cross/aspect

EG. https://bsro.tireconnect.ca/api/size/215/60

Request Parameters

Parameter(s)example value and explanation if neededRequired
cross215 (Cross Section).  inputYES
aspect60 (Aspect Ratio). inputYES
Output 
{
  "statusCode": "SUCCESSFUL",
  "payload": {
    "rim": [
      {
        "value": "15",
        "text": "15"
      },
      {
        "value": "16",
        "text": "16"
      },
      {
        "value": "17",
        "text": "17"
      }
    ]
  }
}

Output description

valuepathcomment
statusCoderoot.statusCode=SUCCESSFUL
payloadroot.payloadNODE
rimroot.payload.aspectNODE
valueroot.payload.rim[].valueThis is an integer value represented as string. 9.5 will be 950
textroot.payload.rim[].textThis is a text value. Something, that may be shown in dropdownlistbox.

Note:

 All data actual for our catalog. For example if we do not have any tire with 15 rim size we won’t show it.

Exception:

if nothing found : {"statusCode":"VALIDATION_ERROR","message":"Sorry, there is no information available on the requested product."}

4. Vehicle Years

Explanation:

Show all available vehicle years for drop down list.

Action: GET

URL: https://bsro.tireconnect.ca/api/by_vehicle

EG. https://bsro.tireconnect.ca/api/by_vehicle

Output 
{
  "statusCode": "SUCCESSFUL",
  "payload": {
    "year": [
      "2020",
      "2019",
      "2018",
      "2017",
      "2016",
      "2015",
      "2014",
      "2013",
      "2012",
      "2011",
      "2010",
      "2009",
      "2008",
      "2007",
      "2006",
      "2005",
      "2004",
      "2003",
      "2002",
      "2001",
      "2000",
      "1999",
      "1998",
      "1997",
      "1996",
      "1995",
      "1994",
      "1993",
      "1992",
      "1991",
      "1990",
      "1989",
      "1988",
      "1987",
      "1986",
      "1985",
      "1984",
      "1983"
    ]
  }
}

Output description

Field name(required data)pathcommentlink
statusCoderoot.statusCodeConst = “SUCCESSFUL”
payloadroot.payloadNODE
"year"root.payload.yearNODE
arrayroot.payload.year[]model_yearMODEL_YEAR

Note:

Service used to get vehicles model Year. Tire search widget will use this service to populate the year drop down.


5. Vehicles Makes by year

Explanation:

To show all available vehicles make by year for drop down list.

Action: GET

URL: https://bsro.tireconnect.ca/api/by_vehicle/{year}

EG. https://bsro.tireconnect.ca/api/by_vehicle/2010

Request Parameters

Parameter(s)example value and explanation if neededRequired
year2010YES
Output(trimmed) 
{
  "statusCode": "SUCCESSFUL",
  "payload": {
    "make": [
      {
        "makeId": "58",
        "name": "Acura",
        "friendlyName": "acura"
      },
      {
        "makeId": "77",
        "name": "Aston Martin",
        "friendlyName": "aston-martin"
      },
      {
        "makeId": "73",
        "name": "Audi",
        "friendlyName": "audi"
      },
      {
        "makeId": "69",
        "name": "Bentley",
        "friendlyName": "bentley"
      },
      {
        "makeId": "31",
        "name": "BMW",
        "friendlyName": "bmw"
      },
      {
        "makeId": "95",
        "name": "Bugatti",
        "friendlyName": "bugatti"
      },
      {
        "makeId": "45",
        "name": "Buick",
        "friendlyName": "buick"
      },
      {
        "makeId": "46",
        "name": "Cadillac",
        "friendlyName": "cadillac"
      },
      {
        "makeId": "47",
        "name": "Chevrolet",
        "friendlyName": "chevrolet"
      },
      {
        "makeId": "39",
        "name": "Chrysler",
        "friendlyName": "chrysler"
      },
      .....................
    ]
  }
}

Output description

Field name(required data)pathcommentlink
statusCoderoot.statusCodeConst = “SUCCESSFUL”
payloadroot.payloadNODE
"make"root.payload.makeNODE
"makeId"root.payload.make[].makeIdstringMAKE_ID
"name"root.payload.make[].nametextMAKE_NAME
“friendlyName”root.payload.make[].friendlyNametextGenerated value based on “name”

Note:

Service used to get vehicle make Id’s and Names by year. Tire search widget will use this service to populate the make drop down.

6. Vehicles Models by year and makeId

Explanation:

To show all available vehicles models by year and make for drop down list.

Action: GET

URL: https://bsro.tireconnect.ca/api/by_vehicle/{year}/{makeId}

EG. https://bsro.tireconnect.ca/api/by_vehicle/2010/47

Request Parameters

Parameter(s)example value and explanation if neededRequired
year2010YES
makeId47YES
Output(trimmed) 
{
  "statusCode": "SUCCESSFUL",
  "payload": {
    "model": [
      {
        "modelId": "2857",
        "makeId": "47",
        "name": "Avalanche",
        "friendlyName": "avalanche"
      },
      {
        "modelId": "2418",
        "makeId": "47",
        "name": "Aveo",
        "friendlyName": "aveo"
      },
      {
        "modelId": "6804",
        "makeId": "47",
        "name": "Aveo5",
        "friendlyName": "aveo5"
      },
      {
        "modelId": "432",
        "makeId": "47",
        "name": "Camaro",
        "friendlyName": "camaro"
      },
      ...............
    ]
  }
}

Output description

Field name(required data)pathcommentlink
statusCoderoot.statusCodeConst = “SUCCESSFUL”
payloadroot.payloadNODE
"model"root.payload.modelNODE
"modelId"root.payload.model[].modelId
MODEL_ID
"makeId"root.payload.model[].makeIdstringMAKE_ID
"name"root.payload.model[].nametextMAKE_NAME
“friendlyName”root.payload.model[].friendlyNametextGenerated value based on “name”

Note:

Service used to get vehicle model Id’s and Names by year & makeId. Tire search widget will use this service to populate the model drop down.

7. Vehicle Submodels by year, makeId and model

Explanation:

To show all available vehicles submodels by year, make and model for drop down list.

Action: GET

URL: https://bsro.tireconnect.ca/api/by_vehicle/{year}/{makeId}/{modelId}

EG. https://bsro.tireconnect.ca/api/by_vehicle/2010/47/2484

Request Parameters

Parameter(s)example value and explanation if neededRequired
year2010YES
makeId47YES
modelId2484YES
Output 
{
  "statusCode": "SUCCESSFUL",
  "payload": {
    "submodel": [
      {
        "name": "LT",
        "friendlyName": "lt",
        "modelId": "2484",
        "submodelId": "430",
        "acesVehicleId": "143885",
        "tpmsInd": "1"
      },
      {
        "name": "WT",
        "friendlyName": "wt",
        "modelId": "2484",
        "submodelId": "444",
        "acesVehicleId": "143886",
        "tpmsInd": "1"
      }
    ]
  }
}

Output description

Field name(required data)pathcommentlink
statusCoderoot.statusCodeConst = “SUCCESSFUL”
payloadroot.payloadNODE
"submodel"root.payload.submodelNODE
"modelId"root.payload.submodel[].modelId
MODEL_ID
"submodelId"root.payload.submodel[].submodelIdstringSUBMODEL_ID
"name"root.payload.submodel[].nametextSUBMODEL
“friendlyName”root.payload.make[].friendlyNametextGenerated value based on “name”
"acesVehicleId"root.payload.submodel[].acesVehicleIdstringVEHTYPE
"tpmsInd"root.payload.submodel[].tpmsIndstringTPMS_IND

Note:

Service used to get vehicle submodel (Trim) Id, acesVehicleId and Name by year & make id & model id. Tire search widget will use this service to populate the submodel (Trim) drop down.

8. Search tire by Size

Explanation:

To show all available tires with same size params.

Action: GET

URL: https://bsro.tireconnect.ca/api/search/by_size?cross={cross}&aspect={aspect}&rim={rim}

EG. https://bsro.tireconnect.ca/api/search/by_size?cross=195&aspect=65&rim=15

Request Parameters

Parameter(s)example value and explanation if neededRequired
cross225 (Cross Section). Optional input if acesVehicleId is passed.YES
aspect65 (Aspect Ratio). Optional input if acesVehicleId is passed.YES

rim

16 (Rim Diameter). Optional input if acesVehicleId is passed.YES
websourceFCAC (Optional if we need to filter by websource)NO
Output(trimmed) 
{
  "statusCode": "SUCCESSFUL",
  "payload": {
	"tireSize": {
  	"crossSection": "195",
  	"aspectRatio": "65",
  	"rimSize": "15"
	},
	"tires": {
  	"240": {
    	"tire": {
      	"article": "240",
      	"brand": "Firestone",
      	"tireName": "Affinity Touring S4 FF",
      	"tireGroupName": "Passenger Tires",
      	"tireClassName": "Car & Minivan All-Season",
      	"tireSegmentName": "Touring",
      	"tireSize": "P195/65R15",
      	"tireType": "All-Season",
      	"loadIndex": "89",
      	"loadIndexPounds": "1279",
      	"tireVehType": "Car & Minivan",
      	"speedRating": "H",
      	"speedRatingMPH": "130",
      	"sidewallDescription": "Black Letter/Black Wall",
      	"mileage": "50000",
      	"technology": "NONE",
      	"warrantyName": "Gold Pledge Limited Warranty",
      	"description": "AFFINITY TOURING S4 FF P195/65R15 89H BL",
      	"bestInClass": "false",
      	"generateCatalogPage": "Y",
      	"oemFlag": "Y",
      	"discontinued": "N",
      	"tireBrandName": "Affinity",
      	"tireBrandImage": "https://bsro.tireconnect.ca/images/brands/fcac-logo-Affinity.png"
    	},
    	"pwsMarketing": [],
    	"tireSurveyDetails": {
      	"dryTraction": "N/A",
      	"wetTraction": "N/A",
      	"tractionInSnowIce": "N/A",
      	"tireStability": "N/A",
      	"noiseLevel": "N/A",
      	"rideComfort": "N/A",
      	"tireWear": "N/A"
    	}
  	},
  	"1400": {
    	"tire": {
      	"article": "1400",
      	"brand": "Firestone",
      	"tireName": "Firehawk AS",
      	"tireGroupName": "Performance",
      	"tireClassName": "Ultra High Performance All Season",
      	"tireSegmentName": "Performance Tires",
      	"tireSize": "195/65R15",
      	"tireType": "All-Season",
      	"loadIndex": "91",
      	"loadIndexPounds": "1356",
      	"tireVehType": "Performance",
      	"speedRating": "H",
      	"speedRatingMPH": "130",
      	"sidewallDescription": "Black Letter/Black Wall",
      	"mileage": "50000",
      	"technology": "NONE",
      	"warrantyName": "Gold Pledge Limited Warranty",
      	"description": "FIREHAWK AS 195/65R15 91H BL",
      	"bestInClass": "false",
      	"generateCatalogPage": "Y",
      	"oemFlag": "N",
      	"discontinued": "N",
      	"tireBrandName": "Firehawk",
      	"tireBrandImage": "https://bsro.tireconnect.ca/images/brands/fcac-logo-Firehawk.png"
    	},
    	"pwsMarketing": [],
    	"tireSurveyDetails": {
      	"dryTraction": "N/A",
      	"wetTraction": "N/A",
      	"tractionInSnowIce": "N/A",
      	"tireStability": "N/A",
      	"noiseLevel": "N/A",
      	"rideComfort": "N/A",
      	"tireWear": "N/A"
    	}
  	},
  	"1667": {
    	"tire": {
      	"article": "1667",
      	"brand": "Bridgestone",
      	"tireName": "Ecopia EP422 Plus",
      	"tireGroupName": "Performance",
      	"tireClassName": "Touring H/V/Z Tires",
      	"tireSegmentName": "Performance Tires",
      	"tireSize": "195/65R15",
      	"tireType": "All-Season",
      	"loadIndex": "91",
      	"loadIndexPounds": "1356",
      	"tireVehType": "Car & Minivan",
      	"speedRating": "H",
      	"speedRatingMPH": "130",
      	"sidewallDescription": "Black Letter/Black Wall",
      	"mileage": "70000",
      	"technology": "NONE",
      	"warrantyName": "Platinum Pact Limited Warranty",
      	"description": "ECOPIA EP422 PLUS 195/65R15 91H BL",
      	"bestInClass": "false",
      	"generateCatalogPage": "Y",
      	"oemFlag": "N",
      	"discontinued": "N",
      	"tireBrandName": "Ecopia",
      	"tireBrandImage": "https://bsro.tireconnect.ca/images/brands/fcac-logo-Ecopia.png"
    	},
    	"pwsMarketing": [
      	{
        	"attribute": "MARKETING STATEMENT (ES)",
        	"value": " "
      	},
      	{
        	"attribute": "IMAGES",
        	"images": [
          	[]
        	]
      	},
      	{
        	"attribute": "IMAGES",
        	"images": [
          	{
            	"resultsImage": "http://www.bridgestonetire.com/content/dam/bridgestone/consumer/bst/tires/models/ecopia-ep422-plus/tile.png"
          	},
          	{
            	"quicklookImage": "http://www.bridgestonetire.com/content/dam/bridgestone/consumer/bst/tires/models/ecopia-ep422-plus/quick-look.png"
          	},
          	{
            	"largeImage": "http://www.bridgestonetire.com/content/dam/bridgestone/consumer/bst/tires/models/ecopia-ep422-plus/large.jpg"
          	},
          	{
            	"heroImage": "http://www.bridgestonetire.com/tireimage/ecopia-ep422-plus/hero.png"
          	},
          	{
            	"trioImage": "No Image"
          	},
          	{
            	"Image360": "No Image"
          	},
          	{
            	"treadImage": "http://www.bridgestonetire.com/tireimage/ecopia-ep422-plus/tread.png"
          	},
          	{
            	"CB2Image": "http://www.bridgestonetire.com/content/dam/bridgestone/consumer/bst/tires/models/image-not-available_large-cb2.jpg"
          	},
          	{
            	"tiltedImage": "http://www.bridgestonetire.com/content/dam/bridgestone/consumer/bst/tires/models/ecopia-ep422-plus/tilted.jpg"
          	},
          	{
            	"sideImage": "http://www.bridgestonetire.com/content/dam/bridgestone/consumer/bst/tires/models/ecopia-ep422-plus/side.jpg"
          	},
          	{
            	"frontImage": "http://www.bridgestonetire.com/content/dam/bridgestone/consumer/bst/tires/models/ecopia-ep422-plus/front.jpg"
          	}
        	]
      	},
      	{
        	"attribute": "MARKETING STATEMENT (EN)",
        	"value": "ECOPIA EP422 PL P205/60R16 TLBLPS91H"
      	},
      	{
        	"attribute": "WARRANTIES",
        	"value": "http://www.bridgestonetire.com/customer-care/tire-warranties/full-warranty"
      	},
      	{
        	"attribute": "SEASON",
        	"value": "All Season"
      	},
      	{
        	"attribute": "MARKETING STATEMENT (FR)",
        	"value": "ECOPIA EP422 PL P205/60R16 TLBLPS91H"
      	}
    	],
    	"tireSurveyDetails": {
      	"dryTraction": "N/A",
      	"wetTraction": "N/A",
      	"tractionInSnowIce": "N/A",
      	"tireStability": "N/A",
      	"noiseLevel": "N/A",
      	"rideComfort": "N/A",
      	"tireWear": "N/A"
    	}
  	},
  	.........
  	}
	},
	"allArticles": [
  	"3448",
  	"122596",
  	"240",
  	"5130",
  	"5917",
  	"85893",
  	"107364",
  	"133459",
  	"7091016",
  	"7091032",
  	"7092617",
  	"7094828",
  	"7095127",
  	"7097646",
  	"2240",
  	"15131",
  	"1667",
  	"5332",
  	"6036",
  	"11442",
  	"106650",
  	"7092473",
  	"7098568",
  	"1400",
  	"13040",
  	"114028"
	],
	"filters": {
  	"brand": [
    	"Primewell",
    	"Firestone",
    	"Toyo",
    	"Bridgestone",
    	"Pirelli",
    	"Yokohama",
    	"Falken",
    	"Michelin"
  	],
  	"tireType": [
    	"All-Season",
    	"Winter"
  	],
  	"size": [
    	"195/65R15",
    	"P195/65R15"
  	],
  	"tireRating": [
    	"Best in Class"
  	],
  	"mileage": [
    	"2",
    	"1"
  	]
	}
  }
}

Output description

Field or nodepathComment
statusCoderoot.statusCode=”SUCCESSFUL”
payloadroot.payloadNODE
tireSizeroot.payload.tireSizeNODE
crossSectionroot.payload.tireSize.crossSectionCross section which was used.
aspectRatioroot.payload.tireSize.aspectRatioAspect ratio
rimSizeroot.payload.tireSize.rimSizeRim size
tiresroot.payload.tiresNODE
arrayroot.payload.tires[]Article of tire
tireroot.payload.tires[].tireNODE
"article"root.payload.tires[].tire.articlescu
"brand"root.payload.tires[].tire.brandbrand
"tireName"root.payload.tires[].tire.tireNametext
"tireGroupName"root.payload.tires[].tire.tireGroupNametext
"tireClassName"root.payload.tires[].tire.tireClassNametext
"tireSegmentName"root.payload.tires[].tire.tireSegmentNametext
"tireSize"root.payload.tires[].tire.tireSizetext
"tireType"root.payload.tires[].tire.tireType(all-season,summer,winter)
"loadIndex"root.payload.tires[].tire.loadIndexstring
"loadIndexPounds"root.payload.tires[].tire.loadIndexPoundsstring
"tireVehType"root.payload.tires[].tire.tireType(SUV/CUV,Car & Minivan,Winter,Perfomance ...)
"speedRating"root.payload.tires[].tire.speedRatingtext
"speedRatingMPH"root.payload.tires[].tire.speedRatingMPHstring
"sidewallDescription"root.payload.tires[].tire.sidewallDescriptiontext
"mileage"root.payload.tires[].tire.mileagestring
"technology"root.payload.tires[].tire.technologytext
"warrantyName"root.payload.tires[].tire.warrantyNametext
"description"root.payload.tires[].tire.descriptiontext
"bestInClass"root.payload.tires[].tire.bestInClassBoolean as string
“oemFlag”root.payload.tires[].tire.oemFlagstring
“discontinued”root.payload.tires[].tire.discontinuedstring
"tireBrandName"root.payload.tires[].tire.tireBrandNametext
"tireBrandImage"root.payload.tires[].tire.tireBrandImage
pwsMarketingroot.payload.tires[].pwsMarketingMarketing info fetched from PWS, PWS is the only responsible for the format see example of data
tireSurveyDetailsroot.payload.tires[].tireSurveyDetails{}Array with tire survey details
allArticlesroot.payload.allArticlesNODE
arrayroot.payload.allArticles[]List of all articles of search
filtersroot.payload.filtersNODE
"brand"root.payload.filters[].brandList of all brands from search
"tireType"root.payload.filters[].tireTypeList of all tire types from search
"size"root.payload.filters[].sizeList of all sizes from search
"tireRating"root.payload.filters[].tireRating

Filter is returned if response contains at least 1 tire with:

"bestInClass": "true"

Filter is not returned if all tires in response have:

"bestInClass": "false"

“mileage”root.payload.filters[].mileage

"0" - < 30000

"1" - 30000 - 50000 

"2" - >= 50000

Note:

Search all tires in catalog , that have same size. We do not give price or quantity. vehicleId or cross and aspect and rim must be in request

9. Search tire by Vehicles

Explanation:

To show all available tires searched by vehicle.

Action: GET

URL: https://bsro.tireconnect.ca/api/search/by_vehicle?acesVehicleId={acesVehicleId}

EG. https://bsro.tireconnect.ca/api/search/by_vehicle?acesVehicleId=143886

Request Parameters

Parameter(s)example value and explanation if neededRequired
acesVehicleId143886. Optional input if cross/aspect/rim is passedYES
Output(trimmed) 
{
  "statusCode": "SUCCESSFUL",
  "payload": {
	"vehicleFitment": {
  	"year": "2010",
  	"make": "Chevrolet",
  	"model": "Colorado",
  	"submodel": "WT",
  	"acesVehicleId": "143886",
  	"tpmsInd": "true"
	},
	"tires": {
  	"27379": {
    	"tire": {
      	"article": "27379",
      	"brand": "Firestone",
      	"tireName": "Destination A/T ",
      	"tireGroupName": "Light Truck Tires",
      	"tireClassName": "All Terrain Tires",
      	"tireSegmentName": "P Metric Light Truck Tires",
      	"tireSize": "P235/75R16",
      	"tireType": "All-Season",
      	"loadIndex": "106",
      	"loadIndexPounds": "2094",
      	"vehType": "TRK",
      	"tireVehType": "SUV/CUV",
      	"speedRating": "S",
      	"speedRatingMPH": "112",
      	"sidewallDescription": "Outline White Letter",
      	"mileage": "50000",
      	"technology": "NONE",
      	"warrantyName": "Gold Pledge Limited Warranty",
      	"description": "DESTINATION A/T P235/75R16 106S OWL",
      	"bestInClass": "false",
      	"generateCatalogPage": "Y",
      	"oemFlag": "N",
      	"discontinued": "N",
      	"tireBrandName": "Destination",
      	"tireBrandImage": "https://bsro.tireconnect.ca/images/brands/fcac-logo-Destination.png",
      	"frb": "B",
      	"standardOptional": "S"
    	},
    	"pwsMarketing": [
      	{
        	"attribute": "MARKETING STATEMENT (ES)",
        	"value": " "
      	},
      	{
        	"attribute": "MARKETING STATEMENT (FR)",
        	"value": " "
      	},
      	{
        	"attribute": "IMAGES",
        	"images": [
          	[]
        	]
      	},
      	{
        	"attribute": "IMAGES",
        	"images": [
          	{
            	"resultsImage": "http://www.bridgestonetire.com/content/dam/bridgestone/consumer/fst/tire-images/destination-at/trio.png"
          	},
          	{
            	"quicklookImage": "http://www.bridgestonetire.com/content/dam/bridgestone/consumer/fst/tire-images/destination-at/quick-look.png"
          	},
          	{
            	"largeImage": "No Image"
          	},
          	{
            	"heroImage": "http://www.bridgestonetire.com/content/dam/bridgestone/consumer/fst/tire-images/destination-at/hero.png"
          	},
          	{
            	"trioImage": "No Image"
          	},
          	{
            	"Image360": "No Image"
          	},
          	{
            	"treadImage": "No Image"
          	},
          	{
            	"CB2Image": "http://www.bridgestonetire.com/content/dam/bridgestone/consumer/fst/tire-images/destination-at/FST_Destination_AT.jpg"
          	},
          	{
            	"tiltedImage": "http://www.bridgestonetire.com/content/dam/bridgestone/consumer/fst/tire-images/destination-at/FST_Destination_AT.jpg"
          	},
          	{
            	"sideImage": "No Image"
          	},
          	{
            	"frontImage": "No Image"
          	}
        	]
      	},
      	{
        	"attribute": "MARKETING STATEMENT (EN)",
        	"value": "The Firestone Destination A/T is the SUV and light truck all-terrain tire built to adapt to travel in wet or dry weather. It provides solid handling and braking and a smooth, quiet ride."
      	},
      	{
        	"attribute": "FEATURES (EN)",
        	"features": [
          	{
            	"feature": "CO-CS (Computer Optimized Component System)",
            	"benefit": "Maximizes performance by optimizing the appropriate combination of tread design, casing shape, materials, and construction"
          	},
          	{
            	"feature": "O-Bead",
            	"benefit": "Improves uniformity and ride comfort through use of a single continuous strand of cable in the bead construction"
          	},
          	{
            	"feature": "LL Carbon (Long Link)",
            	"benefit": "Helps improve tread wear and resist cracking, chipping and tearing through the use of a special long length carbon structure"
          	},
          	{
            	"feature": "5° Noise Reduction",
            	"benefit": "Produces noise-canceling sound waves to significantly reduce tire noise on road surfaces"
          	},
          	{
            	"feature": "Spiral Wrap",
            	"benefit": "Provides a higher level of uniformity and high speed capability through use of a continuous nylon wrap"
          	}
        	]
      	},
      	{
        	"attribute": "WARRANTIES",
        	"value": "http://www.bridgestonetire.com/customer-care/tire-warranties/full-warranty"
      	},
      	{
        	"attribute": "FEATURES (ES)",
        	"features": [
          	{
            	"feature": "CO-CS (Optimización computarizada de los componentes)",
            	"benefit": "Maximiza el desempeño del neumático al optimizar la combimación apropiada de la carcasa, la mejor selección de los materiales y la construcción."
          	},
          	{
            	"feature": "Novedosa redondez",
            	"benefit": "Mejora la uniformidad y el confort al utilizarse un cable continuo en la construcción del talón"
          	},
          	{
            	"feature": "Carbono de enlace largo (L.L. Carbon)",
            	"benefit": "Ayuda a disminuir el desgaste y lo hace menos propenso a grietas, desconches y desgarres, gracias a una estructura de carbon de enlace largo"
          	},
          	{
            	"feature": "5 grados en la reducción del ruido",
            	"benefit": "Produce ondas sonoras que se contraponen al ruido que produce el rodamiento del neumático sobre la superficie de la carretera y lo reducen considerablemente."
          	},
          	{
            	"feature": "Capas en espiral",
            	"benefit": "Suministra un mayor nivel de uniformidad y capacidad de alta velocidad mediante la capa continua de nilon"
          	}
        	]
      	},
      	{
        	"attribute": "FEATURES (FR)",
        	"features": [
          	{
            	"feature": "Sculpture optimisée pour atténuer le bruit",
            	"benefit": "Procure un roulement doux et silencieux."
          	},
          	{
            	"feature": " Fentes d'épaulement ouvertes",
            	"benefit": " Favorisent une bonne évacuation de l'eau."
          	},
          	{
            	"feature": " Configuration musclée des pavés d'épaulement",
            	"benefit": " Plus de traction sur la neige et dans la boue profonde."
          	},
          	{
            	"feature": " Une sculpture à encoches et à pavés d'épaulement imbriqués",
            	"benefit": " Accroît la prise sur neige et boue."
          	},
          	{
            	"feature": " Lamelles profondes",
            	"benefit": " Donnent une adhérence de qualité sur neige."
          	}
        	]
      	},
      	{
        	"attribute": "SEASON",
        	"value": "All Season"
      	}
    	],
    	"tireSurveyDetails": {
      	"dryTraction": "9.1",
      	"wetTraction": "8.6",
      	"tractionInSnowIce": "8.3",
      	"tireStability": "8.6",
      	"noiseLevel": "8.4",
      	"rideComfort": "8.6",
      	"tireWear": "8.3"
    	}
  	},
  	...........
	"allArticles": [
  	"15828",
  	"10",
  	"133323",
  	"7092627",
  	"97725",
  	"113807",
  	"4013",
  	"5009",
  	"7013026",
  	"7099712",
  	"27379",
  	"140378",
  	"7092284",
  	"3894",
  	"7099825"
	],
	"standardArticles": [
  	"15828",
  	"10",
  	"133323",
  	"7092627",
  	"97725",
  	"113807",
  	"4013",
  	"5009",
  	"7013026",
  	"7099712",
  	"27379",
  	"140378",
  	"7092284",
  	"3894",
  	"7099825"
	],
	"optionalArticles": [],
	"frontArticles": [],
	"rearArticles": [],
	"matchedSetArticles": [],
	"filters": {
  	"brand": [
    	"Bridgestone",
    	"Falken",
    	"Firestone",
    	"Primewell",
    	"Toyo",
    	"Yokohama",
    	"Michelin"
  	],
  	"tireType": [
    	"Winter",
    	"All-Season"
  	],
  	"size": [
    	"215/70R16",
    	"P215/70R16",
    	"P235/75R16",
    	"P235/75R16 XL",
    	"235/75R16 XL"
  	],
  	"matchedset": [],
  	"stdopt": [],
  	"tireRating": [
    	"Best in Class"
  	],
  	"mileage": [
    	"2"
  	]
	}
  }
}

Output description

Field or nodepathComment
statusCoderoot.statusCode=”SUCCESSFUL”
payloadroot.payloadNot needed
vehicleFitmentroot.payload.vehicleFitmentNODE
yearroot.payload.vehicleFitment.yearYear of searching model, when search by vehicle id.
makeroot.payload.vehicleFitment.makeMake
modelroot.payload.vehicleFitment.modelModel
submodelroot.payload.vehicleFitment.submodelsubmodel
acesVehicleIdroot.payload.vehicleFitment.acesVehicleIdstring
tpmsIndroot.payload.vehicleFitment.tpmsIndBoolean as string
tiresroot.payload.tiresNODE
arrayroot.payload.tires[]Article of tire
tireroot.payload.tires[].tireNODE
"article"root.payload.tires[].tire.articlescu
"brand"root.payload.tires[].tire.brandbrand
"tireName"root.payload.tires[].tire.tireNametext
"tireGroupName"root.payload.tires[].tire.tireGroupNametext
"tireClassName"root.payload.tires[].tire.tireClassNametext
"tireSegmentName"root.payload.tires[].tire.tireSegmentNametext
"tireSize"root.payload.tires[].tire.tireSizetext
"tireType"root.payload.tires[].tire.tireType(all-season,summer,winter)
"loadIndex"root.payload.tires[].tire.loadIndexstring
"loadIndexPounds"root.payload.tires[].tire.loadIndexPoundsstring
"tireVehType"root.payload.tires[].tire.tireType(SUV/CUV,Car & Minivan,Winter,Perfomance ...)
"speedRating"root.payload.tires[].tire.speedRatingtext
"speedRatingMPH"root.payload.tires[].tire.speedRatingMPHstring
"sidewallDescription"root.payload.tires[].tire.sidewallDescriptiontext
"mileage"root.payload.tires[].tire.mileagestring
"technology"root.payload.tires[].tire.technologytext
"warrantyName"root.payload.tires[].tire.warrantyNametext
"description"root.payload.tires[].tire.descriptiontext
"bestInClass"root.payload.tires[].tire.bestInClassBoolean as string
“generateCatalogPage”root.payload.tires[].tire.generateCatalogPageY/N as string
“oemFlag”root.payload.tires[].tire.oemFlagY/N as string
“discontinued”root.payload.tires[].tire.discontinuedY/N as string
"tireBrandName"root.payload.tires[].tire.tireBrandNametext
"tireBrandImage"root.payload.tires[].tire.tireBrandImage
"FRB"root.payload.tires[].tire.FRB
"standardOptional"root.payload.tires[].tire.standardOptional
pwsMarketingroot.payload.tires[].pwsMarketingMarketing info fetched from PWS, PWS is the only responsible for the format see example of data
tireSurveyDetailsroot.payload.tires[].tireSurveyDetails{}Array with tire survey details
allArticlesroot.payload.allArticlesNODE
arrayroot.payload.allArticles[]List of all articles of search
standardArticlesroot.payload.standardArticlesNODE
arrayroot.payload.standardArticles[]List of all standard articles from search
optionalArticlesroot.payload.optionalArticlesNODE
arrayroot.payload.optionalArticles[]List of all optional articles from search
frontArticlesroot.payload.frontArticlesNODE
arrayroot.payload.frontArticles{}List of all front articles from search
rearArticlesroot.payload.rearArticlesNODE
arrayroot.payload.rearArticles{}List of all rear articles from search
matchedSetArticlesroot.payload.matchedSetArticlesNODE
arrayroot.payload.matchedSetArticles{}List of all matched set from search
filtersroot.payload.filtersNODE
"brand"root.payload.filters[].brandList of all brands from search
"tireType"root.payload.filters[].tireTypeList of all tire types from search
"size"root.payload.filters[].sizeList of all sizes from search
“matchedset”root.payload.filters[].matchedsetAdditional filter by tires type: front, rear or matched set.
"tireRating"root.payload.filters[].tireRating

Filter is returned if response contains at least 1 tire with:

"bestInClass": "true"

Filter is not returned if all tires in response have:

"bestInClass": "false"

“mileage”root.payload.filters[].mileage

"0" - < 30000

"1" - 30000 - 50000 

"2" - >= 50000

10. Search tire by Brand and Tire Name (Model)

Explanation:

To show all available tires searched by brand and model.

Action: GET

URL: https://bsro.tireconnect.ca/api/search/by_brand/{brand}/{model}

EG. https://bsro.tireconnect.ca/api/search/by_brand/Firestone/AFFINITY%20TOURING

Request Parameters

Parameter(s)example value and explanation if neededRequired
brandFirestoneYES
tireNameDestination LE2YES
Output(trimmed) 
{
  "statusCode": "SUCCESSFUL",
  "payload": {
	"display": {
  	"tireId": "840",
  	"category": "Passenger Tires",
  	"model": "Affinity Touring",
  	"segment": "Touring",
  	"theClass": "Car & Minivan All-Season",
  	"brand": "Firestone",
  	"tireName": "Affinity Touring",
  	"tireType": "All-Season",
  	"tireBrandName": "Affinity",
  	"tireBrandImage": "https://bsro.tireconnect.ca/images/brands/fcac-logo-Affinity.png",
  	"tireDesc": "The Affinity touring tire has the tire looks without the premium price.  A solid center rib coupled with an optimized shoulder element angle and shape delivers a quiet ride.  Wide flow-through grooves contribute to good wet performance.",
  	"vehType": "Car & Minivan",
  	"tireGroupName": "Passenger Tires",
  	"warrantyName": "Gold Pledge Limited Warranty"
	},
	"specs": [
  	{
    	"sku": "117615",
    	"mileage": {
      	"value": "70000"
    	},
    	"traction": {
      	"value": "A"
    	},
    	"sidewall": {
      	"value": "BL",
      	"description": "Black Letter/Black Wall"
    	},
    	"speed": {
      	"value": "T"
    	},
    	"temperature": {
      	"value": "B"
    	},
    	"crossSection": "185",
    	"aspect": "65",
    	"rimSize": "14",
    	"treadwear": "560",
    	"label": "P185/65R14",
    	"loadRange": "NONE",
    	"ply": "NONE",
    	"loadIndex": "85",
    	"loadIndexPounds": "1135",
    	"dd": "Y",
    	"oemFlag": "N",
    	"technology": {
      	"value": "NONE"
    	},
    	"pwsMarketing": [
      	{
        	"attribute": "MARKETING STATEMENT (ES)",
        	"value": " "
      	},
      	{
        	"attribute": "MARKETING STATEMENT (FR)",
        	"value": " "
      	},
      	{
        	"attribute": "IMAGES",
        	"images": [
          	[]
        	]
      	},
      	{
        	"attribute": "IMAGES",
        	"images": [
          	{
            	"resultsImage": "http://www.bridgestonetire.com/content/dam/bridgestone/consumer/fst/tire-images/affinity-touring/trio.png"
          	},
          	{
            	"quicklookImage": "http://www.bridgestonetire.com/content/dam/bridgestone/consumer/fst/tire-images/affinity-touring/quick-look.png"
          	},
          	{
            	"largeImage": "No Image"
          	},
          	{
            	"heroImage": "http://www.bridgestonetire.com/content/dam/fst/tire-images/affinity-touring/hero.png"
          	},
          	{
            	"trioImage": "No Image"
          	},
          	{
            	"Image360": "No Image"
          	},
          	{
            	"treadImage": "http://www.bridgestonetire.com/content/dam/fst/tire-images/affinity-touring/tread.png"
          	},
          	{
            	"CB2Image": "http://www.bridgestonetire.com/content/dam/bridgestone/consumer/fst/tire-images/affinity-touring/FST_Affinity_Touring.jpg"
          	},
          	{
            	"tiltedImage": "http://www.bridgestonetire.com/content/dam/bridgestone/consumer/fst/tire-images/affinity-touring/FST_Affinity_Touring.jpg"
          	},
          	{
            	"sideImage": "No Image"
          	},
          	{
            	"frontImage": "No Image"
          	}
        	]
      	},
      	{
        	"attribute": "MARKETING STATEMENT (EN)",
        	"value": "The Firestone Affinity Touring tire is built to comfortably keep you moving. These all-season tires are built for handling in both wet and dry road conditions while delivering a smooth, quiet ride. Combined with a long 70,000 mile treadwear limited warranty*, you can count on these tires for a long time."
      	},
      	{
        	"attribute": "FEATURES (EN)",
        	"features": [
          	{
            	"feature": "LONG-LASTING TREAD COMPOUND",
            	"benefit": "Offers 70,000 mile treadwear limited warranty*"
          	},
          	{
            	"feature": "DIAGONAL & LATERAL SIPES",
            	"benefit": "Provides traction in snow"
          	},
          	{
            	"feature": "ADVANCED SILICA TREAD COMPOUND",
            	"benefit": "Improves traction in wet conditions"
          	},
          	{
            	"feature": "OPTIMIZED TREAD PATTERN",
            	"benefit": "Delivers a quiet, comfortable ride"
          	},
          	{
            	"feature": " ",
            	"benefit": "*Certain restrictions and limitations apply. See warranty manual for details."
          	}
        	]
      	},
      	{
        	"attribute": "WARRANTIES",
        	"value": "http://www.bridgestonetire.com/customer-care/tire-warranties/full-warranty"
      	},
      	{
        	"attribute": "FEATURES (ES)",
        	"features": [
          	{
            	"feature": "COMPUESTO DE CAUCHO DE LARGA DURACIÓN",
            	"benefit": "Ofrece garantía limitada de 70,000 millas para el desgaste *"
          	},
          	{
            	"feature": "COMPUESTO AVANZADO DE SÍLICE DE LA BANDA",
            	"benefit": "Mejora la tracción en condiciones mojadas"
          	},
          	{
            	"feature": "DIBUJO OPTIMIZADO DE LA BANDA",
            	"benefit": "Ofrece un desplazamiento cómodo y suave"
          	},
          	{
            	"feature": " ",
            	"benefit": "* Aplican ciertas restricciones y limitaciones. Consulte el manual de garantía para obtener más detalles."
          	}
        	]
      	},
      	{
        	"attribute": "FEATURES (FR)",
        	"features": [
          	{
            	"feature": "COMPOSÉ HAUTE DURABILITÉ DE LA BANDE DE ROULEMENT",
            	"benefit": "Permet d’offrir une garantie limitée de 110 000 km contre l'usure de la bande de roulement*"
          	},
          	{
            	"feature": "LAMELLES DIAGONALES ET LATÉRALES",
            	"benefit": "Favorisent l'adhérence sur la chaussée enneigée"
          	},
          	{
            	"feature": "COMPOSÉ DE GOMME ÉVOLUÉ ENRICHI DE SILICE",
            	"benefit": "Accroît l'adhérence sur la chaussée mouillée"
          	},
          	{
            	"feature": "SCULPTURE OPTIMISÉE",
            	"benefit": "Offre un roulement confortable et silencieux"
          	},
          	{
            	"feature": " ",
            	"benefit": "*Certaines restrictions et limites s'appliquent. Voir le manuel de garantie pour les détails."
          	}
        	]
      	},
      	{
        	"attribute": "SEASON",
        	"value": "All Season"
      	}
    	]
  	},
  	............
    	]
  	}
	],
	"features": [
  	{
    	"value": "O-Bead",
    	"benefit": "Improves uniformity and ride comfort through use of a single continuous strand of cable in the bead construction"
  	},
  	{
    	"value": "L.L. Carbon (Long Link)",
    	"benefit": "Helps improve tread wear and resist cracking, chipping and tearing through the use of a special long length carbon structure"
  	},
  	{
    	"value": "Diagonal and Lateral Siping",
    	"benefit": "Provides additional wet and snow traction."
  	},
  	{
    	"value": "CO-CS (Computer Optimized Component System)",
    	"benefit": "Maximizes tire performance by optimizing the appropriate combination of tread design, casing shape, materials, and construction."
  	},
  	{
    	"value": "All-Season Tread Design",
    	"benefit": "Enhances year-round performance with open-slotted shoulders."
  	},
  	{
    	"value": "Polyester Cord Body Plies",
    	"benefit": "Helps provide a smooth ride."
  	},
  	{
    	"value": "Steel belt construction",
    	"benefit": "Adds durability and resists punctures"
  	},
  	{
    	"value": "Silica-based tread compound",
    	"benefit": "Provides outstanding wet performance."
  	}
	],
	"treads": [
  	"560"
	],
	"tracts": [
  	"A"
	],
	"temps": [
  	"B"
	],
	"speeds": [
  	"T",
  	"S",
  	"H"
	],
	"ratings": {
  	"Q": "99",
  	"R": "106",
  	"S": "112",
  	"T": "118",
  	"U": "124",
  	"H": "130",
  	"V": "149",
  	"Z": "149+",
  	"W": "168",
  	"Y": "186",
  	"(Y)": "186+"
	}
  }
}

Output description

Field name(required data)pathComment
statusCoderoot.statusCode=”SUCCESSFUL”
payloadroot.payloadNODE
displayroot.payload.displayNODE
tireIdroot.payload.display.tireIdPRODUCT_ID
categoryroot.payload.display.categoryText with category
modelroot.payload.display.modelEqual to product name
segmentroot.payload.display.segmentText with segment
theClassroot.payload.display.theClassText with class
brandroot.payload.display.brandBrand name, use in search request
tireNameroot.payload.display.tireNameEqual to product name
tireTyperoot.payload.display.tireTypeSummer, winter, all-season, etc - types;
tireBrandNameroot.payload.display.tireBrandNameName of tire brand
tireBrandImageroot.payload.display.tireBrandImageNOT USE. field will have name of image.
tireDescroot.payload.display.tireDesctext
vehTyperoot.payload.display.vehType(SUV/CUV,Car & Minivan,Winter,Perfomance ...)
tireGroupNameroot.payload.display.tireGroupNameName of tire group
warrantyNameroot.payload.display.warrantyNameTire warranty
specsroot.payload.specsArray
skuroot.payload.specs[].skuOr part number without leading zeros or Article.
mileageroot.payload.specs[].mileageNot needed
valueroot.payload.specs[].mileage.valuestring
tractionroot.payload.specs[].tractionNot needed
valueroot.payload.specs[].traction.valuetext
sidewallroot.payload.specs[].sidewallNot needed
valueroot.payload.specs[].sidewall.valuestring
descriptionroot.payload.specs[].sidewall.descriptiontext
speedroot.payload.specs[].speedNot needed
valueroot.payload.specs[].speed.valuetext
temperatureroot.payload.specs[].temperatureNot needed
valueroot.payload.specs[].temperature.valueTemperature code from source
crossSectionroot.payload.specs[].crossSectionCross Section size
aspectroot.payload.specs[].aspectAspect size (or width)
rimSizeroot.payload.specs[].rimSizeRim size
treadwearroot.payload.specs[].treadwearstring
labelroot.payload.specs[].labelSearch string label
loadRangeroot.payload.specs[].loadRange

If label contains “XL” loadRange = XL

Else loadRange = NONE as string

plyroot.payload.specs[].ply

If label contains “XL” ply = XL

Else ply = NONE as string

loadIndexroot.payload.specs[].loadIndexstring
loadIndexPoundsroot.payload.specs[].loadIndexPoundsDescription of loadIndex in pounds
ddroot.payload.specs[].ddY/N
oemFlagroot.payload.specs[].oemFlagY/N
technologyroot.payload.specs[].technology
valueroot.payload.specs[].technology.valueDescription of technology
pwsMarketingroot.payload.specs[].pwsMarketingMarketing info fetched from PWS, PWS is the only responsible for the format.
featuresroot.payload.featuresList of all features linked to this product
treadsroot.payload.treadsList of all treadwear fields in specs array
tractsroot.payload.tractsList of all traction value fields in specs array
tempsroot.payload.tempsList of all temps value fields in specs array
speedsroot.payload.speedsList of all speeds value fields in specs array
ratingsroot.payload.ratingsList of all speed ratings value fields in specs array
isBestInClassTireroot.payload.isBestInClassTireBoolean as string

Note:

Will find all tires from catalogue for response;  if brand not send - must return array of tires.

If tireName has ‘’/’ it can be found in several ways: EG. tireName = Dueler H/L 422 Ecopia

It can be found by: “Dueler HL 422 Ecopia” or “Dueler H L 422 Ecopia”

Also you can search such tires with double tireName url-encoding.


11. Vehicle Makes List

Explanation:

To retrieve the entire distinct vehicle makes. This service will return both the friendly and actual make names.

Action: GET

URL: https://bsro.tireconnect.ca/api/vehicle/reverse

EG. https://bsro.tireconnect.ca/api/vehicle/reverse

Output(trimmed) 
{
  "statusCode": "SUCCESSFUL",
  "payload": {
    "makes": [
      {
        "makeId": "58",
        "name": "Acura",
        "friendlyName": "acura"
      },
      {
        "makeId": "16",
        "name": "Alfa Romeo",
        "friendlyName": "alfa-romeo"
      },
      {
        "makeId": "44",
        "name": "AM General",
        "friendlyName": "am-general"
      },
      {
        "makeId": "66",
        "name": "American Motors",
        "friendlyName": "american-motors"
        ,
        .............
      }
    ]
  }
}

Output description

Field name(required data)pathcommentlink
statusCodestatusCodeConst = “SUCCESSFUL”
payloadroot.payloadNODE
makesroot.payload.makesNODE
makeIdroot.payload.makes[].makeIdstringMAKE_ID
nameroot.payload.makes[].nametextMAKE_NAME
friendlyNameroot.payload.makes[].friendlyNametextGenerated value based on “name”

12. Vehicle Models List by Make

Explanation:

To retrieve the entire distinct vehicle models for a given make.

Action: GET

URL: https://bsro.tireconnect.ca/api/vehicle/reverse/{friendlyMakeName}

EG. https://bsro.tireconnect.ca/api/vehicle/reverse/aston-martin

Request Parameters

Parameter(s)example value and explanation if neededRequired
friendlyMakeNameaston-martinYES
Output(trimmed) 
{
  "statusCode": "SUCCESSFUL",
  "payload": {
    "makeId": "77",
    "makeName": "Aston Martin",
    "makeFriendlyName": "aston-martin",
    "models": [
      {
        "modelId": "1056",
        "name": "DB7",
        "friendlyName": "db7"
      },
      {
        "modelId": "2740",
        "name": "DB9",
        "friendlyName": "db9"
      },
      {
        "modelId": "6821",
        "name": "DBS",
        "friendlyName": "dbs"
      },
      {
        "modelId": "1054",
        "name": "Lagonda",
        "friendlyName": "lagonda"
      },
      {
        "modelId": "21600",
        "name": "One-77",
        "friendlyName": "one-77"
        ,
        .................
      }
    ]
  }
}

Output description

Field name(required data)pathcommentlink
statusCodestatusCodeConst = “SUCCESSFUL”
payloadroot.payloadNODE
makeIdroot.payload.makeIdstringMAKE_ID
makeNameroot.payload.makeNametextMAKE_NAME
makeFriendlyNameroot.payload.makeFriendlyNametextGenerated value based on "makeName"
modelsroot.payload.models[]NODE
modelIdroot.payload.models[].modelIdstring
nameroot.payload.models[].nametext
friendlyNameroot.payload.models[].friendlyNametext

13. Vehicle Years List by Make and Model

Explanation:

To retrieve the entire distinct vehicle models for a given make.

Action: GET

URL: https://bsro.tireconnect.ca/api/vehicle/reverse/{friendlyMakeName}//{friendlyModelName}

EG. https://bsro.tireconnect.ca/api/vehicle/reverse/aston-martin/v8-vantage

Request Parameters

Parameter(s)example value and explanation if neededRequired
friendlyMakeNameaston-martinYES
friendlyModelNamev8-vantageYES
Output 
{
  "statusCode": "SUCCESSFUL",
  "payload": {
    "makeId": "77",
    "makeName": "Aston Martin",
    "makeFriendlyName": "aston-martin",
    "modelId": "2825",
    "modelName": "V8 Vantage",
    "modelFriendlyName": "v8-vantage",
    "years": [
      "2017",
      "2016",
      "2015",
      "2014",
      "2013",
      "2012",
      "2011",
      "2010",
      "2009",
      "2008",
      "2007",
      "2006"
    ]
  }
}

Output description

Field name(required data)pathcommentlink
statusCodestatusCodeConst = “SUCCESSFUL”
payloadroot.payloadNODE
makeIdroot.payload.makeIdstringMAKE_ID
makeNameroot.payload.makeNametextMAKE_NAME
makeFriendlyNameroot.payload.makeFriendlyNametextGenerated value based on "makeName"
modelIdroot.payload.modelIdstring
modelNameroot.payload.modelNamestring
modelFriendlyNameroot.payload.modelFriendlyNamestring
yearsroot.payload.years[]array

14. Vehicle Trims/Submodels List by Model, Make and Year

Explanation:

To retrieve the entire distinct vehicle models for a given make.

Action: GET

URL: https://bsro.tireconnect.ca/api/vehicle/reverse/{friendlyMakeName}//{friendlyModelName}/{year}

EG. https://bsro.tireconnect.ca/api/vehicle/reverse/aston-martin/v8-vantage/2014

Request Parameters

Parameter(s)example value and explanation if neededRequired
friendlyMakeNameaston-martinYES
friendlyModelNamev8-vantageYES
year2014

YES

Output 
{
  "statusCode": "SUCCESSFUL",
  "payload": {
    "makeId": "77",
    "makeName": "Aston Martin",
    "makeFriendlyName": "aston-martin",
    "modelId": "2825",
    "modelName": "V8 Vantage",
    "modelFriendlyName": "v8-vantage",
    "year": "2014",
    "submodels": [
      {
        "name": "S",
        "friendlyName": "s",
        "submodelId": "1",
        "acesVehicleId": "207846",
        "tpmsInd": "1"
      },
      {
        "name": "Base",
        "friendlyName": "base",
        "submodelId": "20",
        "acesVehicleId": "207845",
        "tpmsInd": "1"
      }
    ]
  }
}

Output description

Field name(required data)pathcommentlink
statusCodestatusCodeConst = “SUCCESSFUL”
payloadroot.payloadNODE
makeIdroot.payload.makeIdstringMAKE_ID
makeNameroot.payload.makeNametextMAKE_NAME
makeFriendlyNameroot.payload.makeFriendlyNametextGenerated value based on "makeName"
modelIdroot.payload.modelIdstring
modelNameroot.payload.modelNamestring
modelFriendlyNameroot.payload.modelFriendlyNamestring
yearsroot.payload.years[]array
submodelsroot.payload.submodels[]array
nameroot.payload.submodels[].namestring
friendlyNameroot.payload.submodels[].friendlyNamestring
submodelIdroot.payload.submodels[].submodelIdstring
acesVehicleIdroot.payload.submodels[].acesVehicleIdstring
tpmsIndroot.payload.submodels[].tpmsInd1 or 0 as string

15. Vehicle Id (ACES) by Model, Make, Year and Trim/Submodel

Explanation:

To retrieve the unique Aces vehicle ID for a given year, make and model and submodel friendly names.

Action: GET

URL: https://bsro.tireconnect.ca/api/vehicle/reverse/{friendlyMakeName}//{friendlyModelName}/{year}/{friendlySubmodelName}

EG. https://bsro.tireconnect.ca/api/vehicle/reverse/aston-martin/v8-vantage/2014/s

Request Parameters

Parameter(s)example value and explanation if neededRequired
friendlyMakeNameaston-martinYES
friendlyModelNamev8-vantageYES
year2014

YES

friendlySubmodelNamesYES
Output 
{
  "statusCode": "SUCCESSFUL",
  "payload": {
    "makeId": "77",
    "makeName": "Aston Martin",
    "makeFriendlyName": "aston-martin",
    "modelId": "2825",
    "modelName": "V8 Vantage",
    "modelFriendlyName": "v8-vantage",
    "year": "2014",
    "submodelId": "1",
    "submodelName": "S",
    "submodelFriendlyName": "s",
    "acesVehicleId": "207846",
    "tpmsInd": "1"
  }
}

Output description

Field name(required data)pathcommentlink
statusCodestatusCodeConst = “SUCCESSFUL”
payloadroot.payloadNODE
makeIdroot.payload.makeIdstringMAKE_ID
makeNameroot.payload.makeNametextMAKE_NAME
makeFriendlyNameroot.payload.makeFriendlyNametextGenerated value based on "makeName"
modelIdroot.payload.modelIdstring
modelNameroot.payload.modelNamestring
modelFriendlyNameroot.payload.modelFriendlyNamestring
yearroot.payload.yearstring
submodelIdroot.payload.submodelIdstring
submodelNameroot.payload.submodelNamestring
submodelFriendlyNameroot.payload.submodelFriendlyNamestring
acesVehicleIdroot.payload.acesVehicleIdstring
tpmsIndroot.payload.tpmsInd1 or 0 as string

16. Size Rims List

Explanation:

To retrieve the entire distinct vehicle rim diameter values .

Action: GET

URL: https://bsro.tireconnect.ca/api/size/reverse

EG. https://bsro.tireconnect.ca/api/size/reverse

Output 
{
  "statusCode": "SUCCESSFUL",
  "payload": {
    "sizes": [
      {
        "rimSize": "13",
        "rimText": "13"
      },
      {
        "rimSize": "14",
        "rimText": "14"
      },
      {
        "rimSize": "15",
        "rimText": "15"
      },
      {
        "rimSize": "16",
        "rimText": "16"
      },
      {
        "rimSize": "1650",
        "rimText": "16.50"
      },
      {
        "rimSize": "17",
        "rimText": "17"
      },
      {
        "rimSize": "18",
        "rimText": "18"
      },
      {
        "rimSize": "19",
        "rimText": "19"
      },
      {
        "rimSize": "20",
        "rimText": "20"
      },
      {
        "rimSize": "21",
        "rimText": "21"
      },
      {
        "rimSize": "22",
        "rimText": "22"
      },
      {
        "rimSize": "23",
        "rimText": "23"
      },
      {
        "rimSize": "24",
        "rimText": "24"
      },
      {
        "rimSize": "26",
        "rimText": "26"
      },
      {
        "rimSize": "28",
        "rimText": "28"
      },
      {
        "rimSize": "30",
        "rimText": "30"
      }
    ]
  }
}

Output description

Field name(required data)pathcomment
statusCoderoot.statusCodeConst = “SUCCESSFUL”
payloadroot.payloadNODE
sizesroot.payload.sizesNODE
rimSizeroot.payload.sizes[].rimSizestring
rimTextroot.payload.sizes[].rimTexttext

17. Size Cross and Aspect List By Rim

Explanation:

To retrieve the entire distinct tire sizes for the given vehicle rim diameter value by size.

Action: GET

URL: https://bsro.tireconnect.ca/api/size/reverse/{rim}

EG. https://bsro.tireconnect.ca/api/size/reverse/16

Request Parameters

Parameter(s)example value and explanation if neededRequired
rim16YES
Output(trimmed) 
{
  "statusCode": "SUCCESSFUL",
  "payload": {
    "rimSize": "16",
    "rimText": "16",
    "crossAspects": [
      {
        "crossText": "245",
        "crossValue": "245",
        "aspectText": "50",
        "aspectValue": "50"
      },
      {
        "crossText": "245",
        "crossValue": "245",
        "aspectText": "70",
        "aspectValue": "70"
      },
      {
        "crossText": "245",
        "crossValue": "245",
        "aspectText": "45",
        "aspectValue": "45"
      },
      {
        "crossText": "245",
        "crossValue": "245",
        "aspectText": "75",
        "aspectValue": "75"
      },
      {
        "crossText": "215",
        "crossValue": "215",
        "aspectText": "70",
        "aspectValue": "70"
      },
      ..............
    ]
  }
}

Output description

Field name(required data)pathcomment
statusCoderoot.statusCodeConst = “SUCCESSFUL”
payloadroot.payloadNODE
rimSizeroot.payload.rimSizestring
rimText

root.payload.rimText

string
crossAspectsroot.payload.crossAspects[]NODE
crossTextroot.payload.crossAspects[].crossTextstring
crossValue

root.payload.crossAspects[].crossValue

string
aspectTextroot.payload.crossAspects[].aspectTextstring
aspectValueroot.payload.crossAspects[].aspectValuestring

18. Vehicle Fitment Details

Explanation:

To retrieve vehicle fitment details  for the given Aces Vehicle Id.

Action: GET

URL: https://bsro.tireconnect.ca/api/vehicle/fitment/{acesVehicleId}

EG. https://bsro.tireconnect.ca/api/vehicle/fitment/143886

Request Parameters

Parameter(s)example value and explanation if neededRequired
acesVehicleId143886YES
Output 
{
  "statusCode": "SUCCESSFUL",
  "payload": [
    {
      "acesVehicleId": "143886",
      "tireSize": "P215/70R16",
      "speedRating": "S",
      "standardIndicator": "S",
      "frontRearBoth": "B",
      "frontInflation": "33",
      "rearInflation": "33"
    },
    {
      "acesVehicleId": "143886",
      "tireSize": "P235/75R16",
      "speedRating": "S",
      "standardIndicator": "S",
      "frontRearBoth": "B",
      "frontInflation": "32",
      "rearInflation": "32"
    }
  ]
}

Output description

Field name(required data)pathcomment
statusCoderoot.statusCodeConst = “SUCCESSFUL”
payloadroot.payloadNODE
acesVehicleIdroot.payload[].acesVehicleIdstring
tireSizeroot.payload[].tireSizetext
speedRatingroot.payload[].speedRatingtext
standardIndicatorroot.payload[].standardIndicatortext
frontRearBothroot.payload[].frontRearBothtext
frontInflationroot.payload[].frontInflationtext
rearInflationroot.payload[].rearInflationtext

19.Tires by Category

Explanation:

To get the tire catalog details.

Action: GET

URL: https://bsro.tireconnect.ca/api/tire/category/{category}

EG. https://bsro.tireconnect.ca/api/tire/category/light-truck

Request Parameters

Parameter(s)example value and explanation if neededRequired
categorylight-truck (Any valid categories from {all-tires, winter, light-truck, performance, suv-cuv, car-minivan})YES
Output(trimmed) 
{
  "statusCode": "SUCCESSFUL",
  "payload": {
	"vehicleTypes": {
  	"all-tires": "All Tires",
  	"car-minivan": "Car & Minivan",
  	"light-truck": "Light Truck",
  	"performance": "Performance",
  	"suv-cuv": "SUV/CUV",
  	"winter": "Winter"
	},
	"filters": [
  	"All Terrain Tires",
  	"Highway Tires",
  	"Max Traction Tires"
	],
	"displays": [
  	{
    	"tireId": "1078",
    	"model": "M773",
    	"theClass": "All Terrain Tires",
    	"tireName": "M773",
    	"dryTraction": "9",
    	"rideComfort": "9",
    	"tireWear": "8",
    	"wetTraction": "8",
    	"noiseLevel": "9",
    	"tireStability": "8",
    	"tractionInSnowIce": "7",
    	"tireBrandImage": "https://bsro.tireconnect.ca/images/brands/fcac-logo-Bridgestone.png",
    	"generateCatalogPage": "Y",
    	"isBestInClassTire": "false",
    	"brand": "Bridgestone",
    	"pwsMarketing": [
      	{
        	"attribute": "MARKETING STATEMENT (ES)",
        	"value": " "
      	},
      	{
        	"attribute": "MARKETING STATEMENT (FR)",
        	"value": " "
      	},
      	{
        	"attribute": "IMAGES",
        	"images": [
          	[]
        	]
      	},
      	{
        	"attribute": "IMAGES",
        	"images": [
          	{
            	"resultsImage": "http://www.bridgestonetire.com/content/dam/bridgestone/consumer/bst/tires/models/duravis-m773ii/tile.png"
          	},
          	{
            	"quicklookImage": "http://www.bridgestonetire.com/content/dam/bridgestone/consumer/bst/tires/models/duravis-m773ii/quick-look.png"
          	},
          	{
            	"largeImage": "http://www.bridgestonetire.com/content/dam/bridgestone/consumer/bst/tires/models/duravis-m773ii/large.jpg"
          	},
          	{
            	"heroImage": "http://www.bridgestonetire.com/content/dam/bridgestone/consumer/bst/tires/models/duravis-m773ii/hero.png"
          	},
          	{
            	"trioImage": "No Image"
          	},
          	{
            	"Image360": "No Image"
          	},
          	{
            	"treadImage": "No Image"
          	},
          	{
            	"CB2Image": "http://www.bridgestonetire.com/content/dam/bridgestone/consumer/bst/tires/models/image-not-available_large-cb2.jpg"
          	},
          	{
            	"tiltedImage": "http://www.bridgestonetire.com/content/dam/bridgestone/consumer/bst/tires/models/duravis-m773ii/tilted.jpg"
          	},
          	{
            	"sideImage": "No Image"
          	},
          	{
            	"frontImage": "No Image"
          	}
        	]
      	},
      	{
        	"attribute": "MARKETING STATEMENT (EN)",
        	"value": "Original Equipment (OE) tire on select vehicles. See Sizes and Specifications for Original Equipment fitments."
      	},
      	{
        	"attribute": "WARRANTIES",
        	"value": "http://www.bridgestonetire.com/customer-care/tire-warranties/full-warranty"
      	},
      	{
        	"attribute": "SEASON",
        	"value": "All Season"
      	}
    	]
  	},
  	{
    	"tireId": "1102",
    	"model": "R265",
    	"theClass": "Highway Tires",
    	"tireName": "R265",
    	"dryTraction": "10",
    	"rideComfort": "10",
    	"tireWear": "9",
    	"wetTraction": "8",
    	"noiseLevel": "10",
    	"tireStability": "10",
    	"tractionInSnowIce": "7",
    	"tireBrandImage": "https://bsro.tireconnect.ca/images/brands/fcac-logo-Bridgestone.png",
    	"generateCatalogPage": "Y",
    	"isBestInClassTire": "false",
    	"brand": "Bridgestone",
    	"pwsMarketing": [
      	{
        	"attribute": "MARKETING STATEMENT (ES)",
        	"value": " "
      	},
      	{
        	"attribute": "MARKETING STATEMENT (FR)",
        	"value": " "
      	},
      	{
        	"attribute": "MARKETING STATEMENT (EN)",
        	"value": " "
      	},
      	{
        	"attribute": "IMAGES",
        	"images": [
          	[]
        	]
      	},
      	{
        	"attribute": "IMAGES",
        	"images": [
          	{
            	"resultsImage": "http://www.bridgestonetire.com/content/dam/bridgestone/consumer/bst/tires/models/r265/tile.png"
          	},
          	{
            	"quicklookImage": "http://www.bridgestonetire.com/content/dam/bridgestone/consumer/bst/tires/models/r265/quick-look.png"
          	},
          	{
            	"largeImage": "No Image"
          	},
          	{
            	"heroImage": "http://www.bridgestonetire.com/content/dam/bridgestone/consumer/bst/tires/models/r265/hero.png"
          	},
          	{
            	"trioImage": "No Image"
          	},
          	{
            	"Image360": "No Image"
          	},
          	{
            	"treadImage": "No Image"
          	},
          	{
            	"CB2Image": "http://www.bridgestonetire.com/content/dam/bridgestone/consumer/bst/tires/models/image-not-available_large-cb2.jpg"
          	},
          	{
            	"tiltedImage": "http://www.bridgestonetire.com/content/dam/bridgestone/consumer/bst/tires/models/r265/tilted.jpg"
          	},
          	{
            	"sideImage": "No Image"
          	},
          	{
            	"frontImage": "No Image"
          	}
        	]
      	},
      	{
        	"attribute": "FEATURES (EN)",
        	"features": [
          	{
            	"feature": "RIBBED TREAD DESIGN",
            	"benefit": "Quiet operation and good fuel economy\n"
          	},
          	{
            	"feature": "CIRCUMFERENTIAL TREAD GROOVES",
            	"benefit": "Efficient evacuation and channeling of water that helps reduce hydroplaning and improves wet traction\n"
          	},
          	{
            	"feature": "STEEL BELTS AND POLYESTER BODY CORD",
            	"benefit": "Long original life along with retreadability"
          	}
        	]
      	},
      	{
        	"attribute": "WARRANTIES",
        	"value": "http://www.bridgestonetire.com/customer-care/tire-warranties/full-warranty"
      	},
      	{
        	"attribute": "FEATURES (ES)",
        	"features": [
          	{
            	"feature": "DISEÑO DE LA BANDA DE RODAMIENTO CON COSTILLAS",
            	"benefit": "Desplazamiento silencioso y gran economía en el consumo de combustible\n"
          	},
          	{
            	"feature": "ACANALADURAS EN CIRCUNFERENCIA EN LA BANDA DE RODAMIENTO",
            	"benefit": "Eficaz evacuación y drenaje de agua que ayuda a evitar el hidroplaneo y mejora la tracción sobre superficies mojadas"
          	},
          	{
            	"feature": "CUERPO CON CABLES DE POLIÉSTER Y CINTURONES DE ACERO",
            	"benefit": "Larga duración del neumático y capacidad para recauchutado"
          	}
        	]
      	},
      	{
        	"attribute": "FEATURES (FR)",
        	"features": [
          	{
            	"feature": "SCULPTURE NERVURÉE",
            	"benefit": "Roulement silencieux et bonne économie de carburant\n"
          	},
          	{
            	"feature": "RAINURES CIRCONFÉRENTIELLES",
            	"benefit": "Évacuation et dispersion efficaces de l'eau permettant de réduire l'aquaplanage et d'améliorer l'adhérence sur chaussée mouillée."
          	},
          	{
            	"feature": "CEINTURES EN ACIER ET CÂBLÉS DE POLYESTER",
            	"benefit": "Longue durée de vie initiale avec rechapage"
          	}
        	]
      	},
      	{
        	"attribute": "SEASON",
        	"value": "All Season"
      	}
    	]
  	},
  	......
	]
  }
}

Output description

Field name(required data)pathcommentlink
statusCoderoot.statusCodeConst = “SUCCESSFUL”
payloadroot.payloadNODE
vehicleTypesroot.payload.vehicleTypesobjectObject with available categories
filtersroot.filters{}arrayFilter by theClass tire value
displaysroot.payload.displays[]array
tireIdroot.payload.displays[].tireIdtextProductID
modelroot.payload.displays[].modeltext
theClassroot.payload.displays[].theClasstext
tireNameroot.payload.displays[].tireNametext
dryTractionroot.payload.displays[].dryTractiontext
rideComfortroot.payload.displays[].rideComforttext
tireWearroot.payload.displays[].tireWeartext
wetTraction

root.payload.displays[].wetTraction

text
noiseLevelroot.payload.displays[].noiseLeveltext
tireStabilityroot.payload.displays[].tireStabilitytext
tractionInSnowIceroot.payload.displays[].tractionInSnowIcetext
tireBrandImageroot.payload.displays[].tireBrandImagetext
generateCatalogPageroot.payload.displays[].generateCatalogPagetext
isBestInClassTireroot.payload.displays[].isBestInClassTiretext
brandroot.payload.displays[].brandtext

Note: 

When requested “all-tires” , output contains only tires with category (which is not null).


20. Vehicles By Category

Explanation:

To get the vehicle make model list by vehicle type. This service needs to be used in the links in site map pages.

Action: GET

URL: https://bsro.tireconnect.ca/api/vehicle/category/{category}

EG. https://bsro.tireconnect.ca/api/vehicle/category/light-truck

Request Parameters

Parameter(s)example value and explanation if neededRequired
categorysuv (all-tires, light-truck, suv-cuv, car-minivan)YES
Output(trimmed) 
{
  "statusCode": "SUCCESSFUL",
  "payload": [
	{
  	"makeId": "47",
  	"makeName": "Chevrolet",
  	"makeFriendlyName": "chevrolet",
  	"modelId": "2857",
  	"modelName": "Avalanche",
  	"modelFriendlyName": "avalanche"
	},
	{
  	"makeId": "47",
  	"makeName": "Chevrolet",
  	"makeFriendlyName": "chevrolet",
  	"modelId": "416",
  	"modelName": "Avalanche 1500",
  	"modelFriendlyName": "avalanche-1500"
	},
	{
  	"makeId": "47",
  	"makeName": "Chevrolet",
  	"makeFriendlyName": "chevrolet",
  	"modelId": "417",
  	"modelName": "Avalanche 2500",
  	"modelFriendlyName": "avalanche-2500"
	},
	.........
  ]
}

Output description

Field name(required data)pathcomment
statusCoderoot.statusCodeConst = “SUCCESSFUL”
payloadroot.payload[]NODE
makeIdroot.payload[].makeIdstring
makeNameroot.payload[].makeNametext
makeFriendlyNameroot.payload[].makeFriendlyNametext
modelIdroot.payload[].modelIdtext
modelNameroot.payload[].modelNametext
modelFriendlyNameroot.payload[].modelFriendlyNametext