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

  2. min_quantity

...

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

...

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

...

  • brand

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

  • fet (The Federal Excise Tax (if applicable))

Optional

  • delivery_options - estimated delivery date, shipping cost, etc. can be on item level or location branch level

  • shipping_cost - estimated shipping cost

  • delivery_date - estimated delivery date

  • cutoff - delivery cutoff time

  • locationsbranches.primary - mark of primary location 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 locationsbranches.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–01T10:12:29-03:00",
         "cutoff":"11:00"
      },
      "locationsBranches":[
         {
            "name":"LocationBranch 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–01T10:12:29-03:00",
                "cutoff":"11:00"
            }
         },
         {
            "name":"LocationBranch 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–01T10:12:29-03:00",
                "cutoff":"11:00"
            },
            {
            "name":"LocationBranch 23",
            "id":23,
            "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–01T10:12:29-03:00",
                "cutoff":"11:00"
            }
         }
      ]
   }
]

...

Search by part numbers

 Request structure

 Required

  • part_numbers[] (multiple part numbers should be supported)

Optional

  • locations branches (locations branches ids) - several IDs can be transferred

  • min_quantity

...

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

...

  • brand

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

  • fet (The Federal Excise Tax (if applicable))

Optional

  • delivery_options - estimated delivery date, shipping cost, etc. can be on item level or location branch level

  • shipping_cost - estimated shipping cost

  • delivery_date - estimated delivery date

  • cutoff - delivery cutoff time

  • locationsbranches.primary - mark of primary location 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 locationsbranches.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–01T10:12:29-03:00",
         "cutoff":"11:00"
      },
      "locationsbranches":[
         {
            "name":"LocationBranch 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–01T10:12:29-03:00",
                "cutoff":"11:00"
            }
         },
         {
            "name":"LocationBranch 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–01T10:12:29-03:00",
                "cutoff":"11:00"
            },
            {
            "name":"LocationBranch 23",
            "id":23,
            "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–01T10:12:29-03:00",
                "cutoff":"11:00"
            }
         }
      ]
   }
]

Additional Methods

Get List of Dealer’s

...

Branches

 Request structure

  1. authentication credentials (whichever are applicable) 

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

  3. locationsbranches.primary (optional) mark of primary location 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 locationsbranches.type for example, with values: primary, alternative, other

Response structure

List of Locations branches []

Response example

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

...

  1. po_number

  2. items (multiple tires can be passed)

    1. part_number

    2. brand

    3. quantity

    4. location branch (if applicable)

  3. delivery type

  4. delivery instructions

...

Code Block
languagejson
{
  "po_number": "PO Number",
  "items": [
    {
      "part_number": "000094",
      "brand": "Bridgestone",
      "quantity": 4,
      "locationbranch": 1
    }
  ],
  "delivery_type": 1,
  "delivery_instructions": "Please deliver ASAP"
}

...

  1. order_number (order or invoice number)

  2. status

  3. items

  4. error

  5. shipping_cost (if applicable)

  6. fet (The Federal Excise Tax (if applicable))

  7. shipping_cost - actual shipping cost for provided tire qty from selected locationbranch

  8. delivery_date - estimated delivery date

  9. cutoff - delivery cutoff time

...

Get delivery options

Request structure

  1. locationbranch_id

  2. brand

  3. part_number

  4. quantity

...

Code Block
languagejson
{
  "brand": "Bridgestone",
  "part_number": "000009",
  "locationbranch_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 locationbranch

  4. delivery_date - estimated delivery date

  5. cutoff - delivery cutoff time

...