...
supplier | ||
|---|---|---|
name | Supplier Name | |
nice_name | Supplier Nice Name | |
dependence_quantity | Parameter that tells you that accepted fields or it’s values can depend on tire quantity. | Some suppliers may vary accepted fields and their values based on the tire availability. So in case this param = true we highly recommend calling fields method every time user change quantity. |
dependence_fields | List of fields and it’s values that can be changes according to selected values | If some fields returned in this array, fields or its possible values list can be adjusted when you change the value of these fields |
multiple_branch_ordering | Shows if supplier support multiple branch ordering | true - you can send tires from different branches in one order |
multiple_tires_ordering | Shows if you can send several tires in one order | true - you can send several tires in one order |
has_ordering_fields | Shows if you should send some fields in order | true - fields should be send in order |
branches | Array of supplier branches | |
branch | Branch id | Used for old implementations. Deprecated |
branchid | Branch id | |
quantity | Available qty in branch | |
name | Branch name | |
ship_data | Some shipping rules provided by the supplier | |
address | Warehouse address | |
contact | Warehouse contact details | |
estimated_delivery_date | Estimated delivery date provided by the supplier | |
estimated_delivery_time | Estimated delivery time provided by the supplier | |
timezone | Timezone | |
distance | Distance from warehouse (provided by the supplier) | |
distance_unit | Distance unit | |
tire_id | Tire ID | |
price | Tire price | |
quantity | Tire available quantity | |
is_in_stock | Inner fields, not used for direct ordering | |
part_number_original | Supplier part number | |
cost | Tire cost | |
ordering_type | Show it branch should be used in requests | base - branch shouldn’t be used in requests |
...
supplierName | Supplier’s name supplier.name from /api/supplier/stock method or supplier.id from api/v2/location/:location_id:/suppliers method | |
|---|---|---|
tire_id | Tire ID | |
quantity | Tire quantity | |
branch | Tire branch | Some suppliers may vary accepted fields and their values based on the selected branch. |
...
| Code Block | ||
|---|---|---|
| ||
{
"tires": [
{
"tire_id": "QnJpZGdlc3RvbmV8fDAwMzE5M3x8a218fDEyNjc0fHxCUHJpbnh8fDM1MjEyNTA3MDN8fHRpcmVodWJ8fDEyNjc3fHxC",
"branch": null"100",
"cost": 15250.99,
"fet": null,
"fet_source": "tireconnect",
"quantity": 14,
"quantity_available": 32190,
"stock_available": [
{
"branch": "Alternate100",
"id": "Alternate100",
"quantitybranch_type": 5"primary",
"namequantity": "Alternate "190,
"ship_dataname": null "TLC 100 RALEIGH (04\/01\/2024 03:00pm)",
"addressship_data": null,"a. Local customer - based on next available cut-off (Please see in B2B portal). \nb. Within 200 miles, before "contact"2:30 null,PM in a local time zone on a business day - next business day.\nc. 300 miles, "estimated_delivery_date": null,
"estimated_delivery_time": null,
"timezone": nullbefore 2:30 P.M local time business day 2 business days.\ne. Everything else - 3-5 business days.\n\nFor orders made not on a business day, 1 business day is added to projected delivery. 1 day added for Freight orders on Saturdays",
"distanceaddress": {
null, "distance_unitaddress1": null"900 AVIATION PKWY",
}, "address2": null,
{ "branchpostal_code": "National27560-9224",
"idcity": "NationalMORRISVILLE",
"quantityprovince": 27"NC",
"namecountry": "National",null
"ship_data": null},
"addresscontact": null,{
"contactname": null,
"estimatedfirst_delivery_datename": null,
"estimatedlast_delivery_timename": null,
"timezoneemail": null"tlc100raleigh@tirehub.com",
"distance "alt_email": null,
"distance_unitphone": null "919-674-5026",
} "alt_phone": null
] } ], },
"cost": 152, "quantity": 1, "quantity_available": 32, "stockdelivery_date_availabletime": [{
{ "branchdate": "Alternate2024-04-01",
"idtime": "Alternate15:00:00",
"quantity": 5, "nametimezone": "Alternate -04:00",
"ship_data": null, "addressnotes": null,
"contact": null, },
"estimated_delivery_date": null, "cutoff": {
"date": "2024-04-01",
"time": "11:00:00",
"timezone": "-04:00"
},
"distance": 40,
"distance_unit": "ml"
}
]
}
],
"cost": 50.99,
"quantity": 4,
"quantity_available": 190,
"stock_available": [
{
"branch": "100",
"id": "100",
"branch_type": "primary",
"quantity": 190,
"name": "TLC 100 RALEIGH (04\/01\/2024 03:00pm)",
"ship_data": "a. Local customer - based on next available cut-off (Please see in B2B portal). \nb. Within 200 miles, before 2:30 PM in a local time zone on a business day - next business day.\nc. 300 miles, before 2:30 P.M local time business day 2 business days.\ne. Everything else - 3-5 business days.\n\nFor orders made not on a business day, 1 business day is added to projected delivery. 1 day added for Freight orders on Saturdays",
"address": {
"address1": "900 AVIATION PKWY",
"address2": null,
"postal_code": "27560-9224",
"city": "MORRISVILLE",
"province": "NC",
"country": null
},
"contact": {
"name": null,
"first_name": null,
"estimatedlast_delivery_timename": null,
"email": "tlc100raleigh@tirehub.com",
"timezone "alt_email": null,
"distancephone": null"919-674-5026",
"distancealt_unitphone": null
},
"delivery_date_time": {
"branchdate": "National2024-04-01",
"idtime": "National15:00:00",
"quantitytimezone": 27"-04:00",
"namenotes": "National",null
"ship_data": null},
"addresscutoff": null,{
"contactdate": null,"2024-04-01",
"estimated_delivery_datetime": null,"11:00:00",
"estimated_delivery_time "timezone": null,"-04:00"
"timezone": null},
"distance": null40,
"distance_unit": null"ml"
}
],
"total_cost": 152203.96,
"total_fet": 0,
"shipping_cost": null,
"vendor_total_order": 152214,
"deliverytotal_date_timeorder": {
203.96,
"date": "2023-06-25",
"delivery_date_time": "16:45:00",
"timezone": "+02:00"
}null
} |
Response parameters
tire_id | Tire ID | ||
|---|---|---|---|
branch | Branch ID | ||
cost | Tire Cost | ||
fet | FET | ||
quantity | Selected tire quantity | ||
quantity_available | Available quantity for this tire | ||
stock_available | List of branches with quantities where this tire currently available | ||
branch | Branch ID. Deprecated | ||
id | Branch ID | ||
quantity | Quantity available in this branch | ||
name | Branch name | ||
ship_data | Some shipping rules provided by the supplier | ||
address | Warehouse address | ||
contact | Warehouse contact details | ||
estimated_delivery_date | Estimated delivery date provided by the supplier | estimated_delivery_time | Estimated delivery date & time provided by the supplier |
timezonecutoff | TimezoneCutoff | ||
distance | Distance from warehouse (provided by the supplier) | ||
distance_unit | Distance unit | ||
cost | Tire cost | ||
quantity | Selected quantity | ||
quantity_available | Available quantity | ||
total_cost | Total cost of tires in order | ||
total_fet | Total FET | ||
shipping_cost | Total shipping cost | ||
vendor_total_order | Total order counted by vendor. Can be null in case vendor don’t provide this information | ||
total_order | Total order counted by TireConnect | ||
delivery_date_time | Estimated delivery date & time provided by the supplier |
...
| Code Block | ||
|---|---|---|
| ||
{
"tires": [
{
"cost": 90.39,
"tire_id": "QnJpZGdlc3RvbmV8fDAwMzE5M3x8a218fDEyNjc0fHxCTmV4ZW58fDE1MTQ4TlhLfHxhdGRudGR8fDEyNjcxfHxC",
"branch": null,
"costfet": 1520,
"fet_source": null"vendor",
"quantity": 12,
"quantity_available": 326,
"stock_available": [
{
"branch": "Alternatelocal",
"id": "Alternatelocal",
"quantitybranch_type": 5"primary",
"namequantity": "Alternate "6,
"ship_data": nullname": "Local - Same-day delivery (if ordered before cut off time)",
"addressship_data": null,
"contactaddress": null,
"estimated_delivery_datecontact": null,
"estimateddelivery_deliverydate_time": null,{
"timezonedate": null,"2024-04-04",
"distancetime": null,
"distance_unit "timezone": null,
},"notes": null
{},
"branchcutoff": "National",{
"iddate": "National2024-04-03",
"quantitytime": 27"22:30",
"nametimezone": "National-05:00",
"ship_data": null},
"addressdistance": null,
"contactdistance_unit": null,
}
"estimated_delivery_date": null, ],
"estimateddelivery_deliverydate_time": null,
{
"timezonedate": null,
"2024-04-04",
"distancetime": null,
"distance_unit"timezone": null
}
} },
] {
}, {"cost": 58.39,
"tire_id": "QnJpZGdlc3RvbmV8fDAwNjA3MHx8a218fDEyNjc0fHxCSXJvbm1hbnx8OTg0Njl8fGF0ZG50ZHx8MTI2NzF8fEI=",
"branch": null,
"costfet": 1540,
"fet_source": null"vendor",
"quantity": 12,
"quantity_available": 5569,
"stock_available": [
{
"branch": "Alternatelocal",
"id": "Alternatelocal",
"quantitybranch_type": 5"primary",
"namequantity": "Alternate69,
", "ship_data": null"name": "Local - Same-day delivery (if ordered before cut off time)",
"addressship_data": null,
"contactaddress": null,
"estimated_delivery_datecontact": null,
"estimateddelivery_deliverydate_time": {
null, "timezonedate": null"2024-04-04",
"distancetime": null,
"distance_unittimezone": null,
}, "notes": null
{ },
"branch": "National", "cutoff": {
"id": "National", "date": "2024-04-03",
"quantity": 50, "nametime": "National22:30",
"ship_datatimezone": null,"-05:00"
"address": null},
"contactdistance": null,
"estimateddistance_delivery_dateunit": null,
}
"estimated_delivery_time": null, ],
"timezonedelivery_date_time": null,{
"distancedate": null,
"2024-04-04",
"distance_unittime": null,
"timezone": }null
]}
}
],
"cost": 15290.39,
"quantity": 12,
"quantity_available": 326,
"stock_available": [
{
"branch": "Alternatelocal",
"id": "Alternatelocal",
"quantitybranch_type": 5"primary",
"namequantity": "Alternate "6,
"ship_dataname": null,"Local - Same-day delivery (if ordered before cut "address": nulloff time)",
"contactship_data": null,
"estimated_delivery_dateaddress": null,
"estimated_delivery_timecontact": null,
"timezonedelivery_date_time": null,
{
"distance": null, "distance_unitdate": null
}"2024-04-04",
{ "time": null,
"branch": "National", "idtimezone": "National"null,
"quantity": 27, "namenotes": "National",null
"ship_data": null},
"addresscutoff": {
null, "contactdate": null"2024-04-03",
"estimated_delivery_date "time": null,"22:30",
"estimated_delivery_timetimezone": null,"-05:00"
"timezone": null},
"distance": null,
"distance_unit": null
}
],
"total_cost": 306297.56,
"total_fet": 0,
"shipping_cost": null,
"total_order": 306297.56,
"delivery_date_time": {
"date": "20232024-0604-2504",
"time": "16:45:00"null,
"timezone": "+02:00" null
}
} |
Order create method
POST /api/supplier/order/create
...
| Code Block | ||
|---|---|---|
| ||
{
"order_id":16170,
"invoice":"999999999",
"shipping_cost":null,
"vendor_total_order": 312,
"total_order": null,
"tires":[
{
"id":"QnJpZGdlc3RvbmV8fDAwMzE5M3x8a218fDEyNjc0fHxC",
"part_number":"003193",
"quantity_demand":4,
"quantity_ordered":4,
"price":152,
"price_ordered":152,
"status":"Successful",
"message":"Order was placed successfully",
"delivery_date_time":{
"date":"2023-06-25",
"time":"16:45:00",
"timezone":"+02:00"
}
}
],
"status":"Successful",
"message":"The order successfully submitted.",
"delivery_date_time":{
"date":"2023-06-25",
"time":"16:45:00",
"timezone":"+02:00"
}
} |
...
order_id | Order ID in TireConnect system |
|---|---|
invoice | Invoice ID returned by supplier |
shipping_cost | Shipping cost of order |
vendor_total_order | Total order counted by vendor. Can be null in case vendor don’t provide this information |
total_order | Total order counted by TireConnect |
tires | Array of tires |
id | Tire ID |
part_number | Tire part number |
quantity_demand | Requested tire quantity |
quantity_ordered | Ordered tire quantity |
price | Requested tire price |
price_ordered | Ordered tire price |
status | Tire status in order |
message | Message returned by supplier for each tire |
status | Order status |
message | Message returned by supplier for whole order |
delivery_date_time | Estimated Delivery Date & Time provided by the supplier |
...