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 23 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 tire size or part number(s) and receive matching tires 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. width 

  2. profile

  3. rim

Or it can be just size param that will accept raw size.

Optional

  1. branches[] (branch ids) - several IDs can be transferred

  2. min_quantity

 Request example with width, height & rim

{
   "width":205,
   "profile":55,
   "rim":16,
   "branches":[
      1,
      2,
      3
   ],
   "min_quantity":1
}

Request example with size

{
   "size":"2055516",
   "branches":[
      1,
      2,
      3
   ],
   "min_quantity":1
}

Response structure

 List of tires

  • brand

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

  • quantity breakdown (if present)

    • branch 1

    • branch 2

  • cost

  • retail_price (if applicable)

  • fet (The Federal Excise Tax (if applicable))

Optional

  • delivery_options - estimated delivery date, shipping cost, etc. can be on item level or branch level

  • shipping_cost - estimated shipping cost

  • delivery_date - estimated delivery date

  • cutoff - delivery cutoff time

  • branches.primary - mark of primary branch for customer. Can be just true/false in case it’s only primary & other. In case there is an option for customer to have primary, alternative & other it can be branches.type for example, with values: primary, alternative, other

 Response example

[
   {
      "part_number":"000094",
      "brand":"Bridgestone",
      "retail_price":25.5,
      "cost":20,
      "fet":18.4,
      "delivery_options":{
         "shipping_cost":89.41,
         "delivery_date":"2024–12–01T15:00:0-03:00",
         "cutoff":"2024–12–01T10:00:00-03:00"
      },
      "Branches":[
         {
            "name":"Branch 1",
            "id":1,
            "quantity":4,
            "primary": true, //in case it's only primary & other
            "type": "primary", //in case 3 options available
            "delivery_options":{
                "shipping_cost":89.41,
                "delivery_date":"2024–12–01T15:00:0-03:00",
                "cutoff":"2024–12–01T10:00:00-03:00"
            }
         },
         {
            "name":"Branch 2",
            "id":2,
            "quantity":4,
            "primary": false, //in case it's only primary & other
            "type": "alternative", //in case 3 options available
            "delivery_options":{
                "shipping_cost":89.41,
                "delivery_date":"2024–12–01T15:00:0-03:00",
                "cutoff":"2024–12–01T10:00:00-03:00"
            },
            {
            "name":"Branch 3",
            "id":3,
            "quantity":4,
            "primary": false, //in case it's only primary & other
            "type": "other", //in case 3 options available
            "delivery_options":{
                "shipping_cost":89.41,
                "delivery_date":"2024–12–01T15:00:0-03:00",
                "cutoff":"2024–12–01T10:00:00-03:00"
            }
         }
      ]
   }
]

Search by part numbers

 Request structure

 Required

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

Optional

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

  • min_quantity

 Request example

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

Response structure (identical to search by size response)

 List of tires

  • brand

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

  • quantity breakdown (if present)

    • branch 1

    • branch 2

  • cost

  • retail_price (if applicable)

  • fet (The Federal Excise Tax (if applicable))

Optional

  • delivery_options - estimated delivery date, shipping cost, etc. can be on item level or branch level

  • shipping_cost - estimated shipping cost

  • delivery_date - estimated delivery date

  • cutoff - delivery cutoff time

  • branches.primary - mark of primary branch for customer. Can be just true/false in case it’s only primary & other. In case there is an option for customer to have primary, alternative & other it can be branches.type for example, with values: primary, alternative, other

 Response example

[
   {
      "part_number":"000094",
      "brand":"Bridgestone",
      "retail_price":25.5,
      "cost":20,
      "fet":18.4,
      "delivery_options":{
         "shipping_cost":89.41,
         "delivery_date":"2024–12–01T15:00:0-03:00",
         "cutoff":"2024–12–01T10:00:00-03:00"
      },
      "branches":[
         {
            "name":"Branch 1",
            "id":1,
            "quantity":4,
            "primary": true, //in case it's only primary & other
            "type": "primary", //in case 3 options available
            "delivery_options":{
                "shipping_cost":89.41,
                "delivery_date":"2024–12–01T15:00:0-03:00",
                "cutoff":"2024–12–01T10:00:00-03:00"
            }
         },
         {
            "name":"Branch 2",
            "id":2,
            "quantity":4,
            "primary": false, //in case it's only primary & other
            "type": "alternative", //in case 3 options available
            "delivery_options":{
                "shipping_cost":89.41,
                "delivery_date":"2024–12–01T15:00:0-03:00",
                "cutoff":"2024–12–01T10:00:00-03:00"
            },
            {
            "name":"Branch 3",
            "id":3,
            "quantity":4,
            "primary": false, //in case it's only primary & other
            "type": "other", //in case 3 options available
            "delivery_options":{
                "shipping_cost":89.41,
                "delivery_date":"2024–12–01T15:00:0-03:00",
                "cutoff":"2024–12–01T10:00:00-03:00"
            }
         }
      ]
   }
]

Additional Methods

Get List of Dealer’s Branches

 Request structure

  1. authentication credentials (whichever are applicable) 

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

  3. branches.primary (optional) mark of primary branch for customer. Can be just true/false in case it’s only primary & other. In case there is an option for customer to have primary, alternative & other it can be branches.type for example, with values: primary, alternative, other

Response structure

List of branches []

Response example

{
   "branches":[
      {
         "name":"Branch 1",
         "id":1,
         "primary": true, //in case it's only primary & other
         "type": "primary", //in case 3 options available
      },
      {
         "name":"Branch 2",
         "id":2,
         "primary": false, //in case it's only primary & other
         "type": "alternative", //in case 3 options available
      },
      {
         "name":"Branch 3",
         "id":3,
         "primary": false, //in case it's only primary & other
         "type": "other", //in case 3 options available
      }
   ]
}

Submit an order

Request structure

  1. po_number

  2. items (multiple tires can be passed)

    1. part_number

    2. brand

    3. quantity

    4. branch (if applicable)

  3. delivery type

  4. delivery instructions

Request example

{
  "po_number": "PO Number",
  "items": [
    {
      "part_number": "000094",
      "brand": "Bridgestone",
      "quantity": 4,
      "branch": 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)

  6. fet (The Federal Excise Tax (if applicable))

  7. shipping_cost - actual shipping cost for provided tire qty from selected branch

  8. delivery_date - estimated delivery date

  9. cutoff - delivery cutoff time

Response example

{
   "order_number":1236434,
   "status":"Processing",
   "items":[
      {
         "part_number":"000094",
         "quantity":4,
         "price":25.67,
         "fet":18.04,
         "brand":"Bridgestone"
      }
   ],
   "delivery_info":{
      "shipping_cost":89.41,
      "delivery_date":"2024–01–01T10:12:29-03:00"
   },
   "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
}

Get delivery options

Request structure

  1. branch_id

  2. brand

  3. part_number

  4. quantity

Request example

{
  "brand": "Bridgestone",
  "part_number": "000009",
  "branch_id": 1,
  "quantity": 4
}

Response structure

  1. name - delivery method name

  2. id - delivery method id

  3. shipping_cost - actual shipping cost for provided tire qty from selected branch

  4. delivery_date - estimated delivery date

  5. cutoff - delivery cutoff time

Response example

{
   "delivery_options":[
      {
         "name":"UPS",
         "id":1,
         "shipping_cost":89.41,
         "delivery_date":"2024–12–01T15:00:0-03:00",
         "cutoff":"2024–12–01T10:00:00-03:00"
      },
      {
         "name":"FedEx",
         "id":2,
         "shipping_cost":122.41,
         "delivery_date":"2024–12–01T15:00:0-03:00",
         "cutoff":"2024–12–01T10:00:00-03:00"
      },
      {
         "name":"Our Truck",
         "id":3,
         "shipping_cost":52.41,
         "delivery_date":"2024–12–01T15:00:0-03:00",
         "cutoff":"2024–12–01T10:00:00-03:00"
      },
      {
         "name":"PickUp",
         "id":4,
         "shipping_cost":0,
         "delivery_date":"2024–12–01T15:00:0-03:00",
         "cutoff":"2024–12–01T10:00:00-03:00"
      }
   ]
}

  • No labels