Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

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 wheels and it’s catalog data.

Dealer Authentication

All industry standard methods are supported and acceptable. 

Required Methods / Endpoints

List of brands

 Request structure

 Required

No

Optional

  1. offset

  2. limit

 Request example

GET
https://somecatalogapi.com/api/catalog/wheels/brands

Response structure

 List of brands

  • name - Brand Name

  • id - Brand ID

  • logo - Brand Logo (optional, if present)

 Response example

{
  "data": [
    {
      "id": 1,
      "name": "Wheel Brand 1",
      "logo": "https://somecatalogapi.com/uploads/brand/a62696697df65760b3477bf4e025d81b6e409bc0.png"
    },
    {
      "id": 2,
      "name": "Wheel 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/wheels/models?brand_id=1

Response structure

 List of models by requested brand

  • name - Model name

  • id - Model ID

  • brand_id - Brand ID

 Response example

{
  "data": [
    {
      "id": 1,
      "name": "Wheel Brand 1 Model 1",
      "brand_id": 1
    },
    {
      "id": 2,
      "name": "Wheel Brand 1 Model 2",
      "brand_id": 1
    }
  ],
  "meta": {
    "count": 2,
    "total": 1000,
    "offset": 0,
    "limit": 100
  }
}

List of wheels

 Request structure

 Required

  • brand_id

  • model_id

Optional, but preferred

  1. offset

  2. limit

 Request example

GET
https://somecatalogapi.com/api/catalog/wheels/wheels?brand_id=1&model_id=1

Response structure

 List of wheels by brand and model

  • brand_id - Brand ID

  • model_id - Model ID

  • upc - UPC

  • part_number - Part number

  • wheel_width - Width (inches)

  • wheel_diameter - Diameter (inches)

  • et - ET (Offset) (mm)

  • pcd_1 - Main PCD (mm)

  • pcd_2 - Additional PCD (optional, if present)

  • pcd_3 - Additional PCD (optional, if present)

  • bore_min - Minimum Centre Bore (mm) (optional, if present)

  • bore_max - Max Centre Bore (mm)

  • colour - Colour

  • min_wheel_load - Minimum Wheel Load (kg) (optional, if present)

  • wheel_load - Wheel Load (kg)

  • images - List of available Wheel images (angle type - required)

  • weight - Wheel Weight (kg)

  • shipping_weight - Shipping Wheel Weight (kg) (optional, if present)

  • material - Wheel Material

  • winter_approver - Wheel approved for winter usage or no (boolean) (optional, if present)

 Response example

{
  "data": [
    {
      "brand_id": 1,
      "model_id": 1,
      "upc": "757558118007",
      "part_number": "101B-816524",
      "wheel_width": 10.5,
      "wheel_diameter": 18.5,
      "et": 24,
      "pcd_1": "5X114.3",
      "pcd_2": "4X100",
      "pcd_3": "5X112",
      "bore_min": 50.2,
      "bore_max": 70.7,
      "colour": "Gloss Black",
      "min_wheel_load": 700,
      "wheel_load": 1400,
      "images": [
          {
            "type": "angle",
            "url": "https://somecatalogapi.com/wheel/image_angle.png"
      },
      {
            "type": "face",
            "url": "https://somecatalogapi.com/wheel/image_face.png"
      },
      {
            "type": "general",
            "url": "https://somecatalogapi.com/wheel/image_general_1.png"
      }
      ],
      "weight": 30,
      "shipping_weight": 34,
      "material": "Cast Aluminum",
      "winter_approved": 1
    }
  ],
  "meta": {
    "count": 1,
    "total": 1000,
    "offset": 0,
    "limit": 100
  }
}
  • No labels