Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

List of brands

 Request structure

 Required

No

Optional

  1. offset

  2. limit

 Request example

...

  • name - Brand Name

  • id - Brand ID

  • logo - Brand Logo (optional, if present)

 Response example

Code Block
{
  "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

...

  • 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

Code Block
{
  "data": [
    {
      "id": 75,
      "name": "Tire Brand 1 Model 1",
      "brand_id": 24,
      "images": [
        {
          "type": "front",
          "url": "https://somecatalogapi.com/tires/images/brand_1_model_1_front.jpg"
        },
        {
          "type": "angle",
          "url": "https://somecatalogapi.com/tires/images/brand_1_model_1_angle.jpg"
        }
      ],
      "category_id": 9,
      "category_name": "Performance",
      "legal_name": [
        {
          "locale": "en_CA",
          "value": "Tire Brand 1 Model 1©"
        },
        {
          "locale": "en_US",
          "value": "Tire Brand 1 Model 1©"
        },
        {
          "locale": "fr_CA",
          "value": "Tire Brand 1 Model 1™"
        }
      ],
      "features": [
        {
          "locale": "en_CA",
          "list": [
            {
              "feature": "RC Polymer",
              "benefit": "Improves snow and ice performance through use of specific NanoPro-Tech rubber compound."
            },
            {
              "feature": "AC Polymer",
              "benefit": "Improves snow and ice performance through use of specific NanoPro-Tech rubber compound."
            }
          ]
        },
        {
          "locale": "fr_CA",
          "list": [
            {
              "feature": "RC Polymer",
              "benefit": "Improves snow and ice performance through use of specific NanoPro-Tech rubber compound."
            },
            {
              "feature": "AC Polymer",
              "benefit": "Improves snow and ice performance through use of specific NanoPro-Tech rubber compound."
            }
          ]
        }
      ]
    }
  ],
  "meta": {
    "count": 100,
    "total": 1000,
    "offset": 400,
    "limit": 100
  }
}

...

List of tires

 Request structure

 Required

  • brand_id

  • model_id

Optional, but preferred

  1. offset

  2. limit

 Request example

...

  • 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. /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

Code Block
{
  "data": [
    {
      "brand_id": 1,
      "model_id": 1,
      "part_number": "000009",
      "additional_part_numbers": [
        "12345",
        "54321",
        "000-009",
        "BS-9"
      ],
      "size": "P195/65R15",
      "size_desc": "P195/65R15 89H E",
      "size_part_1": "195",
      "size_part_2": "65",
      "size_part_3": "15",
      "load_index_single": 89,
      "load_index_dual": null,
      "speed_rating": "H",
      "load_range": "E",
      "light_truck": false,
      "run_flat": true,
      "_3pmsf": false,
      "mud_snow": false,
      "studdable": "Non-Studded",
      "tire_type": "Passenger",
      "season": "All Season",
      "kilometer_rating": 80000,
      "mileage_rating": 50000,
      "side_wall_style": "BW",
      "prefix": "P",
      "suffix": "",
      "single_max_load": null,
      "single_max_psi": null,
      "dual_max_load": null,
      "dual_max_psi": null,
      "utqg": {
        "wear": 500,
        "traction": "A",
        "temp": "A"
      },
      "application": null,
      "position": null,
      "tread_depth": 11.0,
      "attributes ": [
        "Asymmetrical", "Electric Vehicle Optimized"
     "position": null]
    },
    {
      "brand_id": 1,
      "model_id": 1,
      "part_number": "289779",
      "additional_part_numbers": [],
      "size": "11.00R24",
      "size_desc": "11.00R24 H",
      "size_part_1": "11",
      "size_part_2": "",
      "size_part_3": "24",
      "load_index_single": null,
      "load_index_dual": null,
      "speed_rating": "",
      "load_range": "H",
      "light_truck": false,
      "run_flat": false,
      "_3pmsf": false,
      "mud_snow": false,
      "studdable": "Non-Studded",
      "tire_type": "Medium/Heavy Trucks",
      "season": "All Season",
      "kilometer_rating": 80000,
      "mileage_rating": 50000,
      "side_wall_style": "",
      "prefix": "",
      "suffix": "",
      "single_max_load": 8270,
      "single_max_psi": 120,
      "dual_max_load": 7610,
      "dual_max_psi": 120,
      "utqg": null,
      "application": "Dump Truck",
      "position": "Steer/All Position",
      "tread_depth": 11.0,
      "attributes ": [
        "Asymmetrical", "Electric Vehicle Optimized"
     "position": "Steer/All Position" ]
    },
    {
      "brand_id": 1,
      "model_id": 1,
      "part_number": "184227",
      "additional_part_numbers": [],
      "size": "LT235/75R15",
      "size_desc": "LT235/75R15 C 104/101Q",
      "size_part_1": "235",
      "size_part_2": "75",
      "size_part_3": "15",
      "load_index_single": 104,
      "load_index_dual": 101,
      "speed_rating": "Q",
      "load_range": "C",
      "light_truck": false,
      "run_flat": false,
      "_3pmsf": false,
      "mud_snow": false,
      "studdable": "Non-Studded",
      "tire_type": "Light Truck/SUV",
      "season": "All Season",
      "kilometer_rating": 80000,
      "mileage_rating": 50000,
      "side_wall_style": "BW",
      "prefix": "LT",
      "suffix": "",
      "single_max_load": null,
      "single_max_psi": null,
      "dual_max_load": null,
      "dual_max_psi": null,
      "utqg": {
        "wear": 500,
        "traction": "A",
        "temp": "A"
      },
      "application": null,
      "position": null,
      "tread_depth": 11.0,
      "application": null,
 "attributes ": [
        "Asymmetrical", "Electric Vehicle Optimized"
     "position": null]
    },
    {
      "brand_id": 1,
      "model_id": 1,
      "part_number": "225340",
      "additional_part_numbers": [],
      "size": "225/70R15",
      "size_desc": "225/70R15XL 112/110R",
      "size_part_1": "225",
      "size_part_2": "70",
      "size_part_3": "15",
      "load_index_single": 112,
      "load_index_dual": 110,
      "speed_rating": "R",
      "load_range": "",
      "light_truck": false,
      "run_flat": false,
      "_3pmsf": false,
      "mud_snow": false,
      "studdable": "Non-Studded",
      "tire_type": "Passenger",
      "season": "All Season",
      "kilometer_rating": 80000,
      "mileage_rating": 50000,
      "side_wall_style": "BW",
      "prefix": "",
      "suffix": "XL",
      "single_max_load": null,
      "single_max_psi": null,
      "dual_max_load": null,
      "dual_max_psi": null,
      "utqg": {
        "wear": 500,
        "traction": "A",
        "temp": "A"
      },
      "application": null,
      "position": null,
      "tread_depth": 11.0,
      "attributes ": [
        "Asymmetrical", "Electric Vehicle Optimized"
      ]
    }
  ],
  "meta": {
    "count": 4,
    "total": 1000,
    "offset": 0,
    "limit": 100
  }
}

...

List of categories

 Request structure

 Required

No

Optional

  1. offset

  2. limit

 Request example

...