Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
stylenone

Postman DEMO collection

Search methods Swagger

Demo API key: 89341dcdebfa37018f24ea227a5ca591

...

Get Location ID by External ID

...

Request example

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

Request parameters

Parameter

Value

key

stringquery

API key

Required

external_id

integerquery

Location external ID

Required

Response Example

Code Block
languagejson
{
    "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"
            }
        ]
    }
}

...

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

Code Block
languagejson
{
    "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"
                                }
                            }
                        ]
                    }
                ]
            }
        ]
    }
}

...

token
string

Authorisation token

expire
int

expire time

...

Get PO# by location

Request

...

Example

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

Request parameters

token
query

Dealer location

required

Response Example

Code Block
languagejson
{
    "poNumber": "025240815000"
}

Response Parameters

poNumber
string

PO Number

Simplified Ordering

Request example

Code Block
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

...

Code Block
languagejson
{
    "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