Catalog Web Services Requirements Overview (Tires)
Catalog Web Services Requirements Overview
TireConnect supports wide range of industry standard protocols and connectivity methods.
Outlined below are general requirements which will provide TireConnect platform with the ability to receive list of tires and it’s catalog data.
- 1 Dealer Authentication
- 2 Required Methods / Endpoints
- 2.1 List of brands
- 2.1.1 Request structure
- 2.1.2 Request example
- 2.1.3 Response structure
- 2.1.4 Response example
- 2.2 List of models
- 2.2.1 Request structure
- 2.2.2 Request example
- 2.2.3 Response structure
- 2.2.4 Response example
- 2.3 List of tires
- 2.3.1 Request structure
- 2.3.2 Request example
- 2.3.3 Response structure
- 2.3.4 Response example
- 2.1 List of brands
- 3 Optional Methods / Endpoints
- 3.1 List of categories
- 3.1.1 Request structure
- 3.1.2 Request example
- 3.1.3 Response structure
- 3.1.4 Response example
- 3.1 List of categories
Dealer Authentication
All industry standard methods are supported and acceptable.
Required Methods / Endpoints
List of brands
Request structure
Required
No
Optional
offset
limit
Request example
GET
https://somecatalogapi.com/api/catalog/tires/brandsResponse structure
List of brands
name - Brand Name
id - Brand ID
logo - Brand Logo (optional, if present)
Response example
{
"data": [
{
"id": 1,
"name": "Tire Brand 1",
"logo": "https://somecatalogapi.com/uploads/brand/a62696697df65760b3477bf4e025d81b6e409bc0.png"
},
{
"id": 2,
"name": "Tire Brand 2",
"logo": "https://somecatalogapi.com/uploads/brand/a62696697df65760b1234bf4e025d81b6e503ac2.png"
}
],
"meta": {
"count": 2,
"total": 1000,
"offset": 0,
"limit": 100
}
}
List of models
Request structure
Required
brand_id
Optional
offset
limit
Request example
GET
https://somecatalogapi.com/api/catalog/tires/models?brand_id=1Response structure
List of models by requested brand
id - Model ID
name -Model Name
brand_id - Brand ID
images - List of available tire images
type - Image type (optional, if present)
url - Image url
category_id - Tire Category ID (optional, if present)
category_name - Tire Category Name
legal_name - List of Tire Legal names (optional, if present)
features - List of Tire features (optional, if present)
Response example
List of tires
Request structure
Required
brand_id
model_id
Optional, but preferred
offset
limit
Request example
Response structure
List of tires by requested brand & model
brand_id - Brand ID
model_id - Model ID
part_number - Manufacturer part number
additional_part_numbers - List of additional part numbers
size - Tire size
size_desc - Full tire size including load index, speed rating, etc
size_part_1 - Size part 1
size_part_2 - Size part 2
size_part_3 - Size part 3
load_index_single - Single load index
load_index_dual - Dual load index (optional, if present. In case it’s not present should be null)
speed_rating - Speed rating
load_range - Load range
light_truck - Indicate if this tire is Light Truck (boolean)
run_flat - Indicate if this tire is Run Flat (boolean)
_3pmsf - Indicate if this tire is 3 Peak Mountain Snow Flake (boolean)
mud_snow - Indicate if this tire M+S (boolean)
studdable - Can be one of these values (Studded | Studdable | Non-Studded)
tire_type - Type of tire. Can have one of these values (Not Defined | Passenger | Light Truck/SUV | Medium/Heavy Trucks| Special Trailer | Agriculture | Mining | ATV/UTV)
season - Tire Season. Can have one of these values (Not Defined | All weather | All season | Summer | Winter)
kilometer_rating - Tire Warranty in KM. Can be null if no data
mileage_rating - Tire Warranty in MI. Can be null if no data
side_wall_style - Tire Side Wall
prefix - Prefix for Size Description (optional, if present. In case it’s not present should be empty string)
suffix - Suffix for Size Description (optional, if present. In case it’s not present should be empty string)
single_max_load - Single max load (optional, if present. In case it’s not present should be null)
single_max_psi - Single max psi (optional, if present. In case it’s not present should be null)
dual_max_load - Dual max load (optional, if present. In case it’s not present should be null)
dual_max_psi - Single max psi (optional, if present. In case it’s not present should be null)
utqg - UTQG
application - Application. EG: Line-Haul | Regional | Bus/RV | Urban. (optional, if present. In case it’s not present should be null)
position - Position. EG: Drive | Drive/All Position | Steer/All Position | Trailer. (optional, if present. In case it’s not present should be null)
tread_depth - Tread depth (optional, if present. In case it’s not present should be null)
attributes - List of Attributes. EG: Asymmetrical, Directional, Studdable, Studded, Studless, Non-Highway Service, Electric Vehicle Optimized (optional, if present. In case it’s not present should be null)
Response example
Optional Methods / Endpoints
List of categories
Request structure
Required
No
Optional
offset
limit
Request example
Response structure
List of brands
name - Category Name
id - Category ID