Versions Compared

Key

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

...

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. min_quantity

...

  1. - minimum qty that available in stock

 Request example with width, height & rim

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

Request example with size

Code Block
languagejson
{
   "size":"2055516",
   "branchesmin_quantity":[
      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_optionsinfo - 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

...

Code Block
languagejson
[
   {
      "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_optionsinfo":{

               "shipping_cost":89.41,

               "delivery_date":"2024–12–01T15:00:000-03:00",

               "cutoff":"2024–12–01T10:00:00-03:00"
            }
         },
         {
            "name":"Branch 2",
            "id":2,
            "quantity":4,
            "type": "alternative",
            "delivery_optionsinfo":{

               "shipping_cost":89.41,

               "delivery_date":"2024–12–01T15:00:000-03:00",

               "cutoff":"2024–12–01T10:00:00-03:00"
            },
         },
         {
            "name":"Branch 3",
            "id":3,
            "quantity":4,
            "type": "other",
            "delivery_optionsinfo":{
                "shipping_cost":89.41,
                "delivery_date":"2024–12–01T15:00:000-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 - minimum qty that available in stock

 Request example

{ "part_numbers":[ "000094" ], "branches":[ 1,
Code Block
languagejson
json
{
   "part_numbers":[
  2,       3"000094"
   ],
   "min_quantity":1
}

Response structure (identical to search by size response)

...

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

...

Code Block
languagejson
[
   {
      "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_optionsinfo":{

               "shipping_cost":89.41,

               "delivery_date":"2024–12–01T15:00:000-03:00",

               "cutoff":"2024–12–01T10:00:00-03:00"
            }
         },
         {
            "name":"Branch 2",
            "id":2,
            "quantity":4,
            "type": "alternative",
            "delivery_optionsinfo":{

               "shipping_cost":89.41,

               "delivery_date":"2024–12–01T15:00:000-03:00",

               "cutoff":"2024–12–01T10:00:00-03:00"
            },
         },
         {
            "name":"Branch 3",
            "id":3,
            "quantity":4,
            "type": "other",
            "delivery_optionsinfo":{

               "shipping_cost":89.41,

               "delivery_date":"2024–12–01T15:00:000-03:00",

               "cutoff":"2024–12–01T10:00:00-03:00"
            }
         }
      ]
   }
]

Additional Methods

Get List of Dealer’s Branches

...

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

...