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

...

  • 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

...

Code Block
languagejson
[
   {
      "part_number":"000094",
      "brand":"Bridgestone",
      "retail_price":25.5,
      "cost":20,
      "fet":18.4,
      "delivery_options":{
         "shipping_cost":89.41,
         "delivery_date":"2024–01–01T102024–12–01T15:1200:290-03:00",
         "cutoff":"112024–12–01T10:00:00-03:00"
      },
      "Branches":[
         {
            "name":"Branch 1",
            "id":1,
            "quantity":4,
            "primary": true, //in case it's only primary & other
            "type": "primary", //in case 3 options available
            "delivery_options":{
                "shipping_cost":89.41,
                "delivery_date":"2024–01–01T102024–12–01T15:1200:290-03:00",
                "cutoff":"112024–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–01–01T102024–12–01T15:1200:290-03:00",
                "cutoff":"112024–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–01–01T102024–12–01T15:1200:290-03:00",
                "cutoff":"112024–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

...

  • 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

...

Code Block
languagejson
[
   {
      "part_number":"000094",
      "brand":"Bridgestone",
      "retail_price":25.5,
      "cost":20,
      "fet":18.4,
      "delivery_options":{
         "shipping_cost":89.41,
         "delivery_date":"2024–01–01T102024–12–01T15:1200:290-03:00",
         "cutoff":"112024–12–01T10:00:00-03:00"
      },
      "branches":[
         {
            "name":"Branch 1",
            "id":1,
            "quantity":4,
            "primary": true, //in case it's only primary & other
            "type": "primary", //in case 3 options available
            "delivery_options":{
                "shipping_cost":89.41,
                "delivery_date":"2024–01–01T102024–12–01T15:1200:290-03:00",
                "cutoff":"112024–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–01–01T102024–12–01T15:1200:290-03:00",
                "cutoff":"112024–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–01–01T102024–12–01T15:1200:290-03:00",
                "cutoff":"112024–12–01T10:00:00-03:00"
            }
         }
      ]
   }
]

Additional Methods

Get List of Dealer’s Branches

...

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

...