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

  2. min_quantity - 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
min_quantity":1
}

Request example with size

Code Block
languagejson
{
   "size":"2055516",
   "branchesmin_quantity":[
      1,
      2,
      3
   ],
   "min_quantity":1
}

Response structure


}

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

Code Block
languagejson
[
   {
      "part_number":"000094",
      "brand":"Bridgestone",
      "retail_price":25.5,
      "cost":20,
      "fet":18.4,
      "delivery_optionsbranches":[
         {
            "shipping_costname":89.41,"Branch 1",
            "delivery_dateid":"2024–12–01T15:00:0-03:00"1,
            "cutoffquantity":"2024–12–01T10:00:00-03:00"4,
      },       "Branchestype":[
    "primary",
    {             "name":"Branch 1","delivery_info":{
               "idshipping_cost":189.41,
            "quantity":4,   "delivery_date":"2024–12–01T15:00:00-03:00",
               "cutoff"primary:"2024–12–01T10: true, //in case it's only primary & other00:00-03:00"
            }
       "type": "primary", //in case 3 options available },
         {
            "delivery_optionsname":{
   "Branch 2",
            "shipping_costid":89.412,
            "quantity":4,
         "delivery_date   "type":"2024–12–01T15:00:0-03:00alternative",
                "cutoff":"2024–12–01T10:00:00-03:00""delivery_info":{
            }          }"shipping_cost":89.41,
         {
            "name"delivery_date":"Branch 22024–12–01T15:00:00-03:00",
               "idcutoff":2,"2024–12–01T10:00:00-03:00"
            "quantity":4,}
          },
 "primary": false, //in case it's only primary & other{
            "typename":"Branch "alternative3",
//in   case 3 options available      "id":3,
      "delivery_options      "quantity":4,
            "type":"other",
            "delivery_info":{
                "shipping_cost":89.41,

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

               "cutoff":"2024–12–01T10:00:00-03:00"
            },
          }
 {     ]
       "name":"Branch 3",}
]

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

Code Block
languagejson
{
   "part_numbers":[
      "000094"
   ],
   "id":3,
            "min_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

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

Code Block
languagejson
[
   {
      "part_number":"000094",
      "brand":"Bridgestone",
      "retail_price":25.5,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

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_info":{
               "shipping_cost":89.41,
               "delivery_date":"2024–12–01T15:00:00-03:00",
               "cutoff":"2024–12–01T10:00:00-03:00"
            }
         },
         {
            "costname":20"Branch 2",
      "fet":18.4,
      "delivery_optionsid":{2,
            "shipping_costquantity":89.414,
            "delivery_datetype":"2024–12–01T15:00:0-03:00alternative",
            "cutoff":"2024–12–01T10:00:00-03:00"delivery_info":{
        },       "branchesshipping_cost":[89.41,
         {      "delivery_date":"2024–12–01T15:00:00-03:00",
      "name         "cutoff":"Branch 1",2024–12–01T10:00:00-03:00"
            "id":1,}
         },
  "quantity":4,       {
     "primary": true, //in case it's only primary & other "name":"Branch 3",
            "typeid":3,
"primary", //in case 3 options available            "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"
            }
         },
         {
            "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

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

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

Code Block
languagejson
{
   "branches":[
      {
         "name":"Branch 21",
         "id":2,
         "primary": false, //in case it's only primary & other
 1,
            "type": "alternative", //in case 3 options available "primary"
      },
      {
         "name":"Branch 32",
         "id":32,
         "primarytype": false "alternative"
      },
//in case it's only primary & other{
         "typename":"Branch "other", //in case 3 options available3",
         "id":3,
         "type": "other"
      }
   ]
}

Submit an order

Request structure

...

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