Web Services Requirements Overview (Tires)
Wholesale Web Services Requirements Overview
TireConnect supports wide range of industry standard protocols and connectivity methods.
Outlined below are general requirements which will provide TireConnect platform with the ability to inquire on behalf of a specific dealer with a tire size or part number(s) and receive matching tires with quantity and dealer’s cost.
- 1 Dealer Authentication
- 2 Required Methods / Endpoints
- 2.1 Search by size
- 2.1.1 Request structure
- 2.1.2 Request example with width, height & rim
- 2.1.3 Request example with size
- 2.1.4 Response structure
- 2.1.5 Response example
- 2.2 Search by part numbers
- 2.1 Search by size
- 3 Additional Methods
- 3.1 Get List of Dealer’s Branches
- 3.1.1 Request structure
- 3.1.2 Response structure
- 3.1.3 Response example
- 3.2 Submit an order
- 3.2.1 Request structure
- 3.2.2 Request example
- 3.2.3 Response structure
- 3.2.4 Response example
- 3.3 Get order status
- 3.3.1 Request structure
- 3.3.2 Request example
- 3.3.3 Response structure
- 3.3.4 Response example
- 3.4 Get delivery options
- 3.4.1 Request structure
- 3.4.2 Request example
- 3.4.3 Response structure
- 3.4.4 Response example
- 3.1 Get List of Dealer’s Branches
Dealer Authentication
All industry standard methods are supported and acceptable.
Required Methods / Endpoints
Search by size
Request structure
Required
width
profile
rim
Or it can be just size param that will accept raw size.
Optional
min_quantity - minimum qty that available in stock
Request example with width, height & rim
{
"width":205,
"profile":55,
"rim":16,
"min_quantity":1
}Request example with size
{
"size":"2055516",
"min_quantity":1
}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_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.typefor 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 exampleprimary:true/false
Response example
[
{
"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:0-03:00",
"cutoff":"2024–12–01T10:00:00-03:00"
}
},
{
"name":"Branch 2",
"id":2,
"quantity":4,
"type":"alternative",
"delivery_info":{
"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,
"type":"other",
"delivery_info":{
"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
min_quantity - minimum qty that available in stock
Request example
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.typefor 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 exampleprimary:true/false
Response example
Additional Methods
Get List of Dealer’s Branches
Request structure
authentication credentials (whichever are applicable)
Branch ID (optional, required only if sister stores are available)
branches.type In case there is an option for customer to have primary, alternative & other it can be
branches.typefor 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 exampleprimary:true/false
Response structure
List of branches []
Response example
Submit an order
Request structure
po_number
items (multiple tires can be passed)
part_number
brand
quantity
branch (if applicable)
delivery type
delivery instructions
Request example
Response structure
order_number (order or invoice number)
status
items
error
shipping_cost (if applicable)
fet (The Federal Excise Tax (if applicable))
shipping_cost - actual shipping cost for provided tire qty from selected branch
delivery_date - estimated delivery date
cutoff - delivery cutoff time
Response example
Get order status
Request structure
order_number
Request example
Response structure
order_number
status
error
Response example
Get delivery options
Request structure
branch_id
brand
part_number
quantity
Request example
Response structure
name - delivery method name
id - delivery method id
shipping_cost - actual shipping cost for provided tire qty from selected branch
delivery_date - estimated delivery date
cutoff - delivery cutoff time
Response example