Skip to end of metadata
Go to start of metadata

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

Compare with Current View Version History

Version 1 Next »

Wholesale 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 inquire on behalf of a specific dealer with a wheel size or part number(s) and receive matching wheels with quantity and dealer’s cost.

Dealer Authentication

All industry standard methods are supported and acceptable. 

Required Methods / Endpoints

Search by size

 Request structure

 Required

  1. bolt_pattern (eg 5x114.3) 

  2. diameter

Optional

  1. width (in case it’s present it should be optional in request)

  2. locations[] (locations ids) - several IDs can be transferred

  3. min_quantity

 Request example

{
  "bolt_pattern": 5x114.3,
  "diameter": 20,
  "width": 10,
  "locations": [1,2
  ],
  "min_quantity": 1
}

Response structure

 List of wheels

  • brand_name

  • part_number (manufacturer part number, IMPORTANT: should not contain any other characters)

  • quantity breakdown (if present)

    • location 1

    • location 2

  • cost

  • retail_price (if applicable)

 Response example

[
 {
  "part_number": "123456",
  "brand": "Wheel Brand",
  "retail_price": 250.5,
  "cost": 200,
  "locations": [
              {
                "name": "Location 1",
                “id”: 2, 
                "quantity": 4
              },
              {
                "name": "Location 2",
                "quantity": 4
              }
              ]
  }
]

Search by part numbers

 Request structure

 Required

  • part_numbers[] (multiple part numbers should be supported)

Optional

  • locations (locations ids) - several IDs can be transferred

  • min_quantity

 Request example

{
  "part_numbers": [
    "000094"
  ],
  "locations": [1,2
  ],
  "min_quantity": 1
}

Response structure (identical to search by size response)

 List of wheels

  • brand_name

  • part_number (manufacturer part number, IMPORTANT: should not contain any other characters)

  • quantity breakdown (if present)

    • location 1

    • location 2

  • cost

  • retail_price (if applicable)

 Response example

[
 {
  "part_number": "123456",
  "brand": "Wheel Brand",
  "retail_price": 250.5,
  "cost": 200,
  "locations": [
              {
                "name": "Location 1",
                “id”: 2, 
                "quantity": 4
              },
              {
                "name": "Location 2",
                "quantity": 4
              }
              ]
  }
]

Optional Methods / Endpoints

Get List of Dealer’s Locations

 Request structure

  1. authentication credentials (whichever are applicable) 

  2. location ID (optional, required only if sister stores are available)

Response structure

List of Locations []

Response example

{ "locations": [
  {
  "name": "Location 1",
  “id”: 2
  },
  {
  "name": "Location 2",
  "id": 2
  }
]
}

Submit an order

Request structure

  1. po_number

  2. items (multiple wheels can be passed)

    1. part_number

    2. brand

    3. quantity

    4. location (if applicable)

  3. delivery type

  4. delivery instructions

Request example

{
  "po_number": "PO Number",
  "items": [
    {
      "part_number": "123456",
      "brand": "Wheel Brand",
      "quantity": 4,
      "location": 1
    }
  ],
  "delivery_type": 1,
  "delivery_instructions": "Please deliver ASAP"
}

Response structure

  1. order_number (order or invoice number)

  2. status

  3. items

  4. error

  5. shipping_cost (if applicable)

Response example

{
  "order_number": 1236434,
  "status": "Processing",
  "items": [
    {
      "part_number": "123456",
      "quantity": 4,
      "price": 250.67,
      "brand": "Wheel Brand"
    }
  ],
  "shipping_cost": 13.57,
  "error": null
}

Get order status

Request structure

  1. order_number

Request example

{
  "order_number": 1236434
}

Response structure

  1. order_number

  2. status

  3. error

Response example

{
  "order_number": 1236434,
  "status": "Received",
  "error": null
}

  • No labels