Versions Compared

Key

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

...

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)

...

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

  1. min_quantity - minimum qty that available in stock

 Request example

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

    • location branch 2

  • cost

  • retail_price (if applicable)

 Response example

Code Block
[
   {
      "part_number": "123456",
      "brand": "Wheel Brand",
      "retail_price": 250.5,
      "cost":200,
      "branches":[
         {
            "name":"Branch 2001",
     "locations": [
        "id":1,
            "quantity":4,
            "type":"primary",
            "delivery_info":{
               "shipping_cost":89.41,
"name": "Location 1"               "delivery_date":"2024–12–01T15:00:0-03:00",
               "cutoff":"2024–12–01T10:00:00-03:00"
            }
         },
         {
      “id”:      "name":"Branch 2",
            "id":2,
            "quantity":4,
            "type":"alternative",
            "delivery_info":{
               "shipping_cost":89.41,
               "delivery_date":"2024–12–01T15: 400:0-03:00",
               },"cutoff":"2024–12–01T10:00:00-03:00"
            }
         },
    {     {
            "name":"Branch "Location 2"3",
            "id":3,
            "quantity":4,
            "type":"other",
            "quantity": 4"delivery_info":{
               "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

...

  • min_quantity

 Request example

Code Block
{
   "part_numbers": [
    "000094"
  ],
  "locations000094":
[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 branch 1

    • location branch 2

  • cost

  • retail_price (if applicable)

 Response example

Code Block
[
   {
      "part_number": "123456",
      "brand": "Wheel Brand",
      "retail_price": 250.5,
      "cost": 200,200,
      "branches":[
         {
            "name":"Branch 1",
            "id":1,
            "locationsquantity":4,
 [           "type":"primary",
            "delivery_info":{
               "shipping_cost":89.41,
               "delivery_date":"2024–12–01T15:00:0-03:00",
               "cutoff":"2024–12–01T10:00:00-03:00"
            }
         },
         {
            "name":"Branch "Location 1",2",
            "id":2,
            "quantity":4,
            "type":"alternative",
            “id”: 2, 
"delivery_info":{
               "shipping_cost":89.41,
               "delivery_date":"2024–12–01T15:00:0-03:00",
               "quantitycutoff": 4"2024–12–01T10:00:00-03:00"
            }
         },
         {
         {   "name":"Branch 3",
            "nameid":3,
    "Location 2        "quantity":4,
            "type":"other",
            "delivery_info":{
           "quantity": 4
     "shipping_cost":89.41,
               "delivery_date":"2024–12–01T15:00:0-03:00",
               "cutoff":"2024–12–01T10:00:00-03:00"
            }
         }
      ]
   }
]

Optional Methods / Endpoints

Get List of Dealer’s

...

Branches

 Request structure

  1. authentication credentials (whichever are applicable) 

...

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

Response structure

List of Locations Branches []

Response example

Code Block
{
   "locationsbranches":[
 [     {
         "name":"Branch "Location 1",
  “id”: 2
  },
  {1",
         "id":1,
         "type": "primary"
      },
      {
         "name":"Branch 2",
         "id":2,
         "type": "alternative"
      },
      {
         "name":"Branch "Location 2"3",
         "id":3,
  "id       "type": 2 "other"
      }
   ]
}

Submit an order

Request structure

  1. po_number

  2. items (multiple wheels can be passed)

    1. part_number

    2. brand

    3. quantity

...

    1. branch (if applicable)

  1. delivery type

  2. delivery instructions

Request example

Code Block
languagejson
{
  "po_number": "PO Number",
  "items": [
    {
      "part_number": "123456",
      "brand": "Wheel Brand",
      "quantity": 4,
      "locationbranch": 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

Code Block
{
   "order_number": 1236434,
   "status": "Processing",
   "items":[
[      {
         "part_number": "123456000094",
         "quantity": 4,
         "price": 250.67,25.67,
         "fet":18.04,
         "brand":"Bridgestone"
"Wheel Brand"     }
   ],
   "delivery_info":{
      "shipping_cost":89.41,
      "delivery_date": 13.57"2024–01–01T10:12:29-03:00"
   },
   "error": null
}

Get order status

Request structure

  1. order_number

Request example

Code Block
{
  "order_number": 1236434
}

Response structure

  1. order_number

  2. status

  3. error

Response example

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

Get delivery options

Request structure

  1. branch_id

  2. brand

  3. part_number

  4. quantity

Request example

Code Block
{
  "brand": "Wheel Brand",
  "part_number": "123456",
  "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

Response example

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