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

Optional

  1. locations[] (locations ids) - several IDs can be transferred

  2. min_quantity

 Request example

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

Response structure

 List of tires

  • brand_name

  • part_number (manufacturer part number, IMPORTANT: should not contain any other characters)

  • quantity breakdown (if present)

    • location 1

    • location 2

  • cost

  • retail_price (if applicable)

...

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

Optional

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

  • min_quantity

...

Response structure (identical to search by size response)

 List of tires

  • brand_name

  • part_number (manufacturer part number, IMPORTANT: should not contain any other characters)

  • quantity breakdown (if present)

    • location 1

    • location 2

  • cost

  • retail_price (if applicable)

...

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

Optional Methods / Endpoints

Get List of Dealer’s Locations

 Request structure

  1. authentication credentials (whichever are applicable) 

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

Response structure

List of Locations []

...

Code Block
{ "locations": [
  {
  "name": "Location 1",
  “id”: 21
  },
  {
  "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. location (if applicable)

  3. delivery type

  4. delivery instructions

Request example

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

Response structure

  1. order_number (order or invoice number)

  2. status

  3. items

  4. error

  5. shipping_cost (if applicable)

Response example

Code Block
{
  "order_number": 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. order_number

Request example

Code Block
{
  "order_number": 1236434
}

Response structure

  1. order_number

  2. status

  3. error

Response example

Code Block
{
  "order_number": 1236434,
  "status": "Received",
  "error": null
}

Get delivery options

Request structure

  1. location_id

  2. brand

  3. part_number

  4. quantity

Request example

Code Block
{
  "brand": "Bridgestone",
  "part_number": "000009",
  "location_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 location

Response example

Code Block
{ "delivery_options": [
  {
  "name": "UPS",
  “id”: 1,
  "shipping_cost": 89.41,
  "delivery_date": 01/01/2023
  },
  {
  "name": "FedEx",
  “id”: 2,
  "shipping_cost": 122.41,
  "delivery_date": 01/02/2023
  },
  {
  "name": "Our Truck",
  “id”: 3,
  "shipping_cost": 52.41,
  "delivery_date": 01/03/2023
  },
  {
  "name": "PickUp",
  “id”: 4,
  "shipping_cost": 0,
  "delivery_date": 01/01/2023
  }
]
}