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)

  2. min_quantity - minimum qty that available in stock

...

Code Block
[
   {
      "part_number":"123456",
      "brand":"Wheel Brand",
      "retail_price":250.5,
      "cost":200,
      "branches":[
         {
            "name":"Branch 1",
            "branch_id":1,
            "quantity":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 2",
            "branch_id":2,
            "quantity":4,
            "type":"alternative",
            "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 3",
            "branch_id":3,
            "quantity":4,
            "type":"other",
            "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_number":"123456",
      "brand":"Wheel Brand",
      "retail_price":250.5,
      "cost":200,
      "branches":[
         {
            "name":"Branch 1",
            "branch_id":1,
            "quantity":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 2",
            "branch_id":2,
            "quantity":4,
            "type":"alternative",
            "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 3",
            "branch_id":3,
            "quantity":4,
            "type":"other",
            "delivery_info":{
               "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

...

Code Block
{
   "branches":[
      {
         "name":"Branch 1",
         "branch_id":1,
         "type": "primary"
      },
      {
         "name":"Branch 2",
         "branch_id":2,
         "type": "alternative"
      },
      {
         "name":"Branch 3",
         "branch_id":3,
         "type": "other"
      }
   ]
}

...

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

...

Code Block
{
   "delivery_options":[
      {
         "name":"UPS",
         "iddelivery_type":1,
         "shipping_cost":89.41,
         "delivery_date":"2024–12–01T15:00:0-03:00",
         "cutoff":"2024–12–01T10:00:00-03:00"
      },
      {
         "name":"FedEx",
         "iddelivery_type":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",
         "iddelivery_type":3,
         "shipping_cost":52.41,
         "delivery_date":"2024–12–01T15:00:0-03:00",
         "cutoff":"2024–12–01T10:00:00-03:00"
      },
      {
         "name":"PickUp",
         "iddelivery_type":4,
         "shipping_cost":0,
         "delivery_date":"2024–12–01T15:00:0-03:00",
         "cutoff":"2024–12–01T10:00:00-03:00"
      }
   ]
}

...