1 Get Location ID by External ID
- 1.1 Request example
- 1.2 Request parameters
- 1.3 Response Example
- 1.4 Response parameters
2 Simplified Search
- 2.1 Request example
- 2.2 Request parameters
- 2.3 Response example
- 2.4 Response parameters
3 Get/Refresh Token (Orders Auth)
- 3.1 Request Example
- 3.2 Request parameters
- 3.3 Response Example
- 3.4 Response Parameters
4 Get PO# by location
- 4.1 Request Example
- 4.2 Request parameters
- 4.3 Response Example
- 4.4 Response Parameters
5 Simplified Ordering
- 5.1 Request example
- 5.2 Request parameters
- 5.3 Response example
- 5.4 Response parameters

Demo API key: 89341dcdebfa37018f24ea227a5ca591

Get Location ID by External ID

Request example

curl --location 'https://devdemo.tireconnect.ca/api/v2/location/by_external_id/025?key=89341dcdebfa37018f24ea227a5ca591' \

Request parameters

Parameter	Value

Parameter

Value

key

^query

API key

^Required

external_id

^query

Location external ID

^Required

Response Example

{
    "notice": "Success",
    "data": {
        "locations": [
            {
                "id": 13118,
                "is_active": true,
                "name": "BJS WHSL B025",
                "address_line_1": "3805 HARTZDALE DR",
                "address_line_2": "",
                "city": "CAMP HILL",
                "latitude": 40.217,
                "longitude": -76.9359,
                "province": "Pennsylvania",
                "province_code": "PA",
                "postal_code": "17011-7810",
                "phone": "717-763-9550",
                "contact_name": "Myrah St-Onge",
                "logo": "https://devdemo.tireconnect.ca/uploads/dealer/d06755d1e86461435360ccb2f19072dcd1559cc8.png",
                "dealer_id": 11840,
                "external_id": "025",
                "bs_account_number": "777391",
                "holidays": null,
                "working_hours": null,
                "country": "United States",
                "country_code": "US",
                "mobile_phone": null,
                "email": "bjs0025@bjs.com"
            }
        ]
    }
}

Response parameters

id ^int	Location id
is_active ^boolean	Shows whether the location is active or not
name ^string	Location name
address_line_1 ^string	Address line 1
address_line_2 ^string	Address line 2
city ^string	Location city
latitude ^decimal	Location latitude
longitude ^decimal	Location longitude
province ^string	Location province
province_code ^string	Location province code
postal_code ^string	Location zip/postal code
phone ^string	Location phone number
contact_name ^string	Contact name
logo ^string	Dealer’s logo
dealer_id ^int	Dealer id
external_id ^string	Location external id
bs_account_number ^array	Location Bridgestone account number
holidays ^array	Array with location’s holidays. Can be null
working_hours ^string	Array with location’s working hours
country ^string	Location country
country_code ^string	Location country code
mobile_phone ^string	Location mobile phone
email ^string	Location email

Simplified Search

Request example

curl --location 'https://devdemo.tireconnect.ca/api/v2/tire/search/simplifiedSearch?key=89341dcdebfa37018f24ea227a5ca591' \
--header 'accept: application/json' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'location_id=13118' \
--data-urlencode 'part_numbers%5B0%5D=178720' \
--data-urlencode 'part_numbers%5B1%5D=332104' \
--data-urlencode 'quantity=4'

Request parameters

Parameter	Value

Parameter

Value

key

^string

API key

^Required

location_id

^integer

Location id

^Required

part_numbers[]

^array

Array of part numbers

^Required

quantity

^integer

Desired Quantity. Used to determine suppliers and their branches with enough quantity

^Required

Response example

{
    "notice": "Success",
    "data": {
        "nb_results": 2,
        "tires": [
            {
                "part_number": "000112",
                "brand": "Bridgestone",
                "stock": [
                    {
                        "tire_id": "QnJpZGdlc3RvbmV8fDAwMDExMnx8YnJpZGdlc3RvbmV8fDEzMTE4fHxC",
                        "supplier": "bridgestone",
                        "supplier_name": "Bridgestone",
                        "price": 91.36,
                        "tax": 5.4816,
                        "cost": 91.36,
                        "fet": 0,
                        "fet_source": "tireconnect",
                        "branches": [
                            {
                                "id": "D005",
                                "quantity": 878,
                                "name": "D005 Allentown DC",
                                "delivery_date_time": {
                                    "date": "2024-08-14",
                                    "time": null,
                                    "timezone": null,
                                    "notes": null
                                },
                                "cutoff": null
                            }
                        ]
                    }
                ]
            },
            {
                "part_number": "004405",
                "brand": "Firestone",
                "stock": [
                    {
                        "tire_id": "RmlyZXN0b25lfHwwMDQ0MDV8fHRpcmVodWJ8fDEzMTE4fHxC",
                        "supplier": "tirehub",
                        "supplier_name": "TireHub",
                        "price": 112,
                        "tax": 6.72,
                        "cost": 112,
                        "fet": 0,
                        "fet_source": "tireconnect",
                        "branches": [
                            {
                                "id": "101",
                                "quantity": 61,
                                "name": "TLC 101 BALTIMORE (08/13/2024 12:00pm)",
                                "delivery_date_time": {
                                    "date": "2024-08-13",
                                    "time": "12:00:00",
                                    "timezone": "-04:00",
                                    "notes": null
                                },
                                "cutoff": {
                                    "date": "2024-08-13",
                                    "time": "06:00:00",
                                    "timezone": "-04:00"
                                }
                            }
                        ]
                    }
                ]
            }
        ]
    }
}

Response parameters

Parameter	Value

Parameter	Value
notice ^string	Response status
nb_results ^integer	Number of found tires
part_number ^string	Tire part number
brand ^string	Tire brand
stock[] ^array	Stock information
tire_id ^string	Tire ID
quantity ^integer	Tire quantity
supplier ^string	Supplier id
supplier_name ^string	Supplier name
price ^integer	Tire price
tax ^integer	Tax
cost ^integer	Tire cost
fet ^integer	FET
fet_source ^string	Shows if FET comes from supplier or it’s calculated on TC side. Can be: tireconnect vendor
branches[] ^array	An array with stock per branch
branch ^string	Deprecated parameter
id ^string	Branch ID
quantity ^integer	Tire quantity
name ^string	Branch name
delivery_date_time ^object	Estimated delivery information specific for this branch
date ^string	Estimated delivery date
time ^string	Estimated delivery time
timezone ^string	Time zone
notes ^string	Information about estimated delivery
cutoff ^object	Information about cut off date&time for current branch
date ^string	Cut-off date
time ^string	Cut-off time
timezone ^string	Cut-off time zone

Get/Refresh Token (Orders Auth)

Request Example

curl --location 'https://devdemo.tireconnect.ca/api/account/auth/location' \
--header 'Content-Type: application/json' \
--data '{
    "dealer_location_id": 13118,
    "pin_code": "004003",
    "key": "89341dcdebfa37018f24ea227a5ca591"
}'

Request parameters

dealer_location_id
^int

Dealer location

^required

pin_code
^int

Pin Code

^required

key
^string

API key

^required

Response Example

{
  "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJkZWFsZXJfbG9jYXRpb24iOjEyNjc0LCJleHAiOjE1NjA1MjY1ODl9.uEjbXiu1EoZ5E9IyXDz4JEVySY4C_C5mYXCC6SsGTwOCXyU3tHJU79FJkh5X2uMUlJttIQwoyC1HqljDl7_zIj-6XxvT-ismKDmdW7z7ZqrsGi6N3VACx9Rt1o3aJvBdDkSw4QfqhE8DZlLsYDH-TIGEOUP6E462Rfxn8bE149g",
  "expire": 900
}

Response Parameters

token ^string	Authorisation token
expire ^int	expire time

Get PO# by location

Request Example

curl --location 'https://devdemo.tireconnect.ca/api/supplier/order/poNumberBank?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJkZWFsZXJfbG9jYXRpb24iOjEzMTE4LCJleHAiOjE3MjM3NDAxODR9.ReFfl30rlJCNCFRSo1B3SIZarG0a65ggPYNtegU8VI2wVsLuocGxjz2oHlSYhTRCayllhtoVweyVb1_RT4sCqV271JK0LNLjsdCQS3mQ35Mpte3-9Hgrm8URlKwwoD8EEdh2YeAR0xsfGXAVQaVlRudXnXN72ezhpG4xpHvho64&location_id=13118' \

Request parameters

token
^query

Dealer location

^required

Response Example

{
    "poNumber": "025240815000"
}

Response Parameters

poNumber ^string	PO Number

Simplified Ordering

Request example

curl --location 'https://devdemo.tireconnect.ca/api/supplier/order/create_simplified' \
--header 'Content-Type: application/json' \
--data '{
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJkZWFsZXJfbG9jYXRpb24iOjEzMTE4LCJleHAiOjE3MjM0Nzg3MDJ9.ts5bMXBXxl6jBVZntsw_5PXYMRpph6IVOtP2WYdoTH6KxdHkYkjnmRWUpIKrzpVaCiyMkxbL5pgmC4W2i7-8zeTMs9TH9GD6N41YeqwFcC3sEPYg1p2gNt07d7YnPsaaMKtg5RANvNXmFzvhTNVczR1iqja6EK-8kHeOS9SrhhQ",
    "tires": [
        {
            "tire_id": "RmlyZXN0b25lfHwwMDQ0MDV8fHRpcmVodWJ8fDEzMTE4fHxC",
            "quantity": 1,
            "branch": "101"
        }
    ],
    "po_number": "VVA123456"
}'

Request parameters

token ^string	Authorisation token
tires ^array	Array of tires. Please note that you can place several tires in one orders only in case they have same supplier.
tire_id ^string	Tire ID
quantity ^int	Tire quantity
branch ^string	Supplier branch. You should take this value from `branches.id` in search method
po_number ^string	PO Number

Response example

{
    "orders": [
        {
            "invoice": "22604569",
            "shipping_cost": 0,
            "tires": [
                {
                    "id": "RmlyZXN0b25lfHwwMDQ0MDV8fHRpcmVodWJ8fDEzMTE4fHxC",
                    "part_number": "004405",
                    "quantity_demand": 1,
                    "quantity_ordered": 1,
                    "price": 112,
                    "price_ordered": 112,
                    "status": "Successful",
                    "message": "Submitted",
                    "delivery_date_time": {
                        "date": "2024-08-13",
                        "time": "12:00:00",
                        "timezone": "-04:00"
                    }
                }
            ],
            "status": "Successful",
            "message": "The order successfully submitted."
        }
    ]
}

Response parameters

order_id ^int	Order ID in TireConnect system
invoice ^string	Invoice ID returned by supplier
shipping_cost ^int	Shipping cost of order
tires ^array	Array of tires
id ^string	Tire ID
part_number ^string	Tire part number
quantity_demand ^int	Requested tire quantity
quantity_ordered ^int	Ordered tire quantity
price ^int	Requested tire price
price_ordered ^int	Ordered tire price
status ^string	Tire status in order
message ^string	Message returned by supplier for each tire
status ^string	Order status
message ^string	Message returned by supplier for whole order
delivery_date_time ^object	Estimated Delivery Date & Time provided by the supplier

TireConnect Public

Simplified search & ordering flow for BJ's

Get Location ID by External ID

Request example

Request parameters

Response Example

Response parameters

Simplified Search

Request example

Request parameters

Response example

Response parameters

Get/Refresh Token (Orders Auth)

Request Example

Request parameters

Response Example

Response Parameters

Get PO# by location

Request Example

Request parameters

Response Example

Response Parameters

Simplified Ordering

Request example

Request parameters

Response example

Response parameters

Related content