Versions Compared

Key

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

...

Table of Contents
minLevel1
maxLevel7

Dealer Authentication

All industry standard methods are supported and acceptable. 

Required Methods / Endpoints

Search by size

 Request structure

 Required

  1. width 

  2. profile

  3. rim

  4. authentication credentials (whichever are applicable) 

    1. account number

    2. user name

    3. password

    4. shipTo ID

...

  1. warehouses[] (warehouse ids) - several warehouse id can be transferred

  2. min_quantity

 Request example

Code Block
{
  "width": 205,
  "height": 205,
  "rim": 205,
  "warehouses": [1,2
  ],
  "min_quantity": 1
}

Response structure

 List of tires

  • brand_name

  • part_number (clean manufacturer part number)

  • model (optional)

  • quantity breakdown (if present)

    • warehouse 1

    • warehouse 2

  • cost

  • price (if present)

 Response example

Code Block
[
 {
  "part_number": 000094,
  "brand": "Bridgestone",
  "price": 25.5,
  "cost": 20,
  "branches": [
              {
                "name": "Location 1",
                “id”: 2, 
                "quantity": 4
              },
              {
                "name": "Location 2",
                "quantity": 4
              }
              ]
  }
]

Search by part numbers

 Request structure

 Required

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

...

  • warehouses (warehouse ids) - several warehouse id can be transferred

  • min_quantity

 Request example

Code Block
{
  "part_numbers": [
    "000094"
  ],
  "warehouses": [1,2
  ],
  "min_quantity": 1
}

Response structure

 List of tires

  • brand_name

  • part_number (clean manufacturer part number)

  • model (optional)

  • quantity breakdown (if present)

    • warehouse 1

    • warehouse 2

  • cost

  • price (if present)

 Response example

Code Block
[
 {
  "part_number": 000094,
  "brand": "Bridgestone",
  "price": 25.5,
  "cost": 20,
  "branches": [
              {
                "name": "Location 1",
                “id”: 2, 
                "quantity": 4
              },
              {
                "name": "Location 2",
                "quantity": 4
              }
              ]
  }
]

Optional Methods / Endpoints

Get Dealer’s ShipTo IDs

 Request structure

  1. authentication credentials (whichever are applicable) 

  2. account number

  3. user name

  4. password 

Response structure

List of Ship To IDs []

Response example

Code Block
{ "branches": [
  {
  "name": "Location 1",
  “id”: 2
  },
  {
  "name": "Location 2",
  "id": 2
  }
]
}

Submit an order

Request structure

  1. po_number

  2. items (multiple tires can be passed)

    1. part_number

    2. brand

    3. quantity

    4. warehouse (if applicable for orders per branch)

  3. delivery type

  4. delivery instructions

Request example

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

Response structure

  1. invoice

  2. status

  3. items

  4. error

  5. shipping_cost

Response example

Code Block
{
  "invoice": 1236434,
  "status": "Processing",
  "items": [
    {
      "part_number": "000094",
      "quantity": 4,
      "price": 25.67,
      "brand": "Bridgestone"
    }
  ],
  "shipping_cost": 13.57,
  "error": null
}

Get order status

Request structure

  1. invoice

Request example

Code Block
{
  "invoice": 1236434
}

Response structure

  1. invoice

  2. status

  3. error

Response example

Code Block
{
  "invoice": 1236434,
  "status": "Successful",
  "error": null
}

...