...
Search by size
Request structure
Required
width
profile
rim
Or it can be just size param that will accept raw size.
Optional
locations[] (locations ids) - several IDs can be transferred
min_quantitymin_quantity - minimum qty that available in stock
Request example with width, height & rim
Code Block | ||
---|---|---|
| ||
{ "width":205, "profile":55, "rim":16, "locations":[ 1, 2 ], "min_quantity":1 } |
Request example with size
Code Block | ||
---|---|---|
| ||
{ "size":"2055516", "locationsmin_quantity":[ 1, 2 ], "min_quantity":1 }1 } |
Response structure
List of tires
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
shippingdelivery_costinfo - estimated delivery date, shipping costdelivery_, etc. can be on item level or branch level
shipping_cost - estimated shipping cost
delivery_date - estimated delivery date
cutoff - delivery cutoff time
Response example
...
language | json |
---|
...
branches.type 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. 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
Code Block | ||
---|---|---|
| ||
[ { "part_number":"000094", "brand":"Bridgestone", "retail_price":25.5, "cost":20, "fet":18.4, "delivery_optionsbranches":{[ "shipping_cost":89.41,{ "delivery_datename":"2024–01–01T10:12:29-03:00Branch 1", "cutoffid":"11:00"1, }, "locationsquantity":[4, { "type":"primary", "name "delivery_info":"Location 1",{ "idshipping_cost":189.41, "quantity":4 } "delivery_date":"2024–12–01T15:00:00-03:00", { "cutoff":"2024–12–01T10:00:00-03:00" "name":"Location 2", } "id":2,}, { "quantityname":4"Branch 2", } "id":2, ] } ] |
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
Request example
Code Block | ||
---|---|---|
| ||
{ "part_numbersquantity":[4, "type":"000094alternative", ], "locationsdelivery_info":[{ 1"shipping_cost":89.41, 2 ], "mindelivery_quantity":1 } |
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)
location 1
location 2
cost
retail_price (if applicable)
fet (The Federal Excise Tax (if applicable))
Optional
shipping_cost - estimated shipping cost
delivery_date - estimated delivery date
cutoff - delivery cutoff time
Response example
Code Block | ||
---|---|---|
| ||
[ {date":"2024–12–01T15:00:00-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:00-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
Code Block | ||
---|---|---|
| ||
{
"part_numbers":[
"000094"
],
"min_quantity":1
} |
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.type
for 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
Code Block | ||
---|---|---|
| ||
[ { "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:00-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:00-03:00", "cutoff":"2024–12–01T10:00:00-03:00" } }, { "name":"Branch 3", "id":3, "quantity":4, "type":"other", "partdelivery_numberinfo":"000094",{ "brand":"Bridgestone", "retailshipping_pricecost":2589.541, "cost":20, "delivery_date":"2024–12–01T15:00:00-03:00", "fet":18.4, "cutoff"delivery_options:":{2024–12–01T10:00:00-03:00" "shipping_cost":89.41, } "delivery_date":"2024–01–01T10:12:29-03:00", } ] "cutoff":"11:00" }, "locations":[ { "name":"Location 1", "id":1, "quantity":4 }, { "name":"Location 2",} ] |
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.type
for 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
Code Block | ||
---|---|---|
| ||
{ "branches":[ { "id":2, "quantity":4 } "name":"Branch 1", ] } ] |
Additional Methods
Get List of Dealer’s Locations
Request structure
authentication credentials (whichever are applicable)
location ID (optional, required only if sister stores are available)
Response structure
List of Locations []
Response example
Code Block | ||
---|---|---|
| ||
{"id":1, "locationstype":[ "primary" }, { "name":"Location 1","Branch 2", "id":2, "type": "idalternative":1 }, { "name":"LocationBranch 23", "id":2":3, "type": "other" } ] } |
Submit an order
Request structure
po_number
items (multiple tires can be passed)
part_number
brand
quantity
location branch (if applicable)
delivery type
delivery instructions
...
Code Block | ||
---|---|---|
| ||
{ "po_number": "PO Number", "items": [ { "part_number": "000094", "brand": "Bridgestone", "quantity": 4, "locationbranch": 1 } ], "delivery_type": 1, "delivery_instructions": "Please deliver ASAP" } |
...
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 locationbranch
delivery_date - estimated delivery date
cutoff - delivery cutoff time
...
Code Block | ||
---|---|---|
| ||
{ "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
...
Get delivery options
Request structure
locationbranch_id
brand
part_number
quantity
...
Code Block | ||
---|---|---|
| ||
{ "brand": "Bridgestone", "part_number": "000009", "locationbranch_id": 1, "quantity": 4 } |
Response structure
name - delivery method name
id - delivery method id
shipping_cost - actual shipping cost for provided tire qty from selected locationbranch
delivery_date - estimated delivery date
cutoff - delivery cutoff time
...
Code Block | ||
---|---|---|
| ||
{ "delivery_options":[ { "name":"UPS", "id":1, "shipping_cost":89.41, "delivery_date":"2024–01–01T102024–12–01T15:1200:2900-03:00", "cutoff":"112024–12–01T10:00:00-03:00" }, { "name":"FedEx", "id":2, "shipping_cost":122.41, "delivery_date":"2024–01–02T102024–12–01T15:1200:2900-03:00", "cutoff":"112024–12–01T10:00:00-03:00" }, { "name":"Our Truck", "id":3, "shipping_cost":52.41, "delivery_date":"2024–01–03T102024–12–01T15:1200:2900-03:00", "cutoff":"112024–12–01T10:00:00-03:00" }, { "name":"PickUp", "id":4, "shipping_cost":0, "delivery_date":"2024–01–04T102024–12–01T15:1200:2900-03:00", "cutoff":"112024–12–01T10:00:00-03:00" } ] } |