...

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. locations[] (locations ids) - several IDs can be transferred

2. min_quantity - minimum qty that available in stock

 Request example with width, height & rim

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

Request example with size

{
   "size":"2055516",
   "locationsmin_quantity":[
      1,
      2
   ],
   "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)

  • location branch 1

  • location branch 2

• cost

• retail_price (if applicable)

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

Optional

• delivery_info - 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

 Response example

...

...

• branches.type 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. Or it can be just mark of primary branch for customer. Can be just true/false in case it’s only primary & other, for example primary: true/false

 Response example

[
   {
      "part_number":"000094",
      "brand":"Bridgestone",
      "retail_price":25.5,
      "cost":20,
      "fet":18.4,
      "delivery_optionsbranches":{[
         {
 "shipping_cost":89.41,           "delivery_datename":"2024–01–01T10:12:29-03:00Branch 1",
            "cutoffid":"11:00"
1,
     },       "locationsquantity":[
         {4,
            "nametype":"Location 1primary",
            "iddelivery_info":1,{
               "quantity":4
         }shipping_cost":89.41,
         {      "delivery_date":"2024–12–01T15:00:00-03:00",
               "namecutoff":"Location 2",2024–12–01T10:00:00-03:00"
            "id":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

{"name":"Branch 2",
            "id":2,
            "part_numbersquantity":[4,
      "000094"    ],
   "locationstype":["alternative",
      1,      "delivery_info":{
2    ],           "shipping_cost":89.41,
    "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)

  • location 1

  • location 2

• cost

• retail_price (if applicable)

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

Optional

• shipping_cost - estimated shipping cost

• delivery_date - estimated delivery date

• cutoff - delivery cutoff time

 Response example

[           "delivery_date":"2024–12–01T15:00:00-03:00",
               "cutoff":"2024–12–01T10:00:00-03:00"
            }
         },
         {
            "name":"Branch 3",
            "id":3,
            "quantity":4,
            "type":"other",
            "delivery_info":{
               "shipping_cost":89.41,
               "delivery_date":"2024–12–01T15:00:00-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

• min_quantity - minimum qty that available in stock

 Request example

{
   "part_numbers":[
      "000094"
   ],
   "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_info - 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.type 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. Or it can be just mark of primary branch for customer. Can be just true/false in case it’s only primary & other, for example primary: true/false

 Response example

[
   {
      "part_number":"000094",
      "brand":"Bridgestone",
      "retail_price":25.5,
      "cost":20,
      "fet":18.4,
      "branches":[
         {
            "name":"Branch 1",
            "id":1,
            "quantity":4,
            "type":"primary",
            "delivery_info":{
               "shipping_cost":89.41,
               "delivery_date":"2024–12–01T15:00:00-03:00",
               "cutoff":"2024–12–01T10:00:00-03:00"
            }
         },
         {
            "name":"Branch 2",
            "id":2,
            "quantity":4,
            "type":"alternative",
            "delivery_info":{
               "shipping_cost":89.41,
               "delivery_date":"2024–12–01T15:00:00-03:00",
               "cutoff":"2024–12–01T10:00:00-03:00"
            }
         },
         {
      "part_number      "name":"000094Branch 3",
      "brand      "id":"Bridgestone",3,
         "retail_price   "quantity":25.5,4,
            "type"cost:"other":20,
      "fet":18.4,       "delivery_optionsinfo":{
               "shipping_cost":89.41,
               "delivery_date":"2024–01–01T102024–12–01T15:1200:2900-03:00",
               "cutoff":"112024–12–01T10:00:00-03:00"
            },
         }
 "locations":[     ]
    {
            "name":"Location 1",
            "id":1,
            "quantity":4
         },
  }
]

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.type 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. Or it can be just mark of primary branch for customer. Can be just true/false in case it’s only primary & other, for example primary: true/false

Response structure

List of branches []

Response example

{
   "branches":[
      {

           "name":"LocationBranch 21",
            "id":21,
  
         "quantitytype":4
         }
      ]
   }
]

Additional Methods

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":[ "primary"
      },
      {
         "name":"LocationBranch 12",
         "id":2,
         ":1type": "alternative"
      },
      {
         "name":"Location 2""Branch 3",
         "id":3,
         "id":2"type": "other"
      }
   ]
}

Submit an order

Request structure

1. po_number

2. items (multiple tires can be passed)

   1. part_number

   2. brand

   3. quantity

   4. location branch (if applicable)

3. delivery type

4. delivery instructions

Request example

{
  "po_number": "PO Number",
  "items": [
    {
      "part_number": "000094",
      "brand": "Bridgestone",
      "quantity": 4,
      "locationbranch": 1
    }
  ],
  "delivery_type": 1,
  "delivery_instructions": "Please deliver ASAP"
}

...

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 locationbranch

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_optionsinfo":{
      "shipping_cost":89.41,
      "delivery_date":"2024–01–01T10:12:29-03:00",
 
    "cutoff":"11:00"
   },
   "error":null
}

Get order status

...

Request example

{
  "order_number": 1236434
}

...

Response example

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

...

Get delivery options

Request structure

1. locationbranch_id

2. brand

3. part_number

4. quantity

Request example

{
  "brand": "Bridgestone",
  "part_number": "000009",
  "locationbranch_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 locationbranch

4. delivery_date - estimated delivery date

5. cutoff - delivery cutoff time

Response example

...

example

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