...

Request parameters

dealer_location_id
^int
^query^body

Dealer location

^required

pin_code
^int
^query^body

Pin Code

^required

key
^string
^query^body

API key

^required

Response Example

...

POST /api/supplier/dropship/order/preview/

This method methods will provide you with the most recent information about order including delivery date & time and delivery fee.

...

token

^query

Authorisation token

^required

tire_id

_string

^query

Tire ID

^required

quantity

^int^query

Tire Quantity
^required

address_line_1

_string^query

Address Line 1
^required

address_line_2
^query^string

Address Line 2
^optional

city

_string
^query

City
^required

province

_string^query

Province
^required

country

_string^query

Country
^required

postal_code

_string^query

ZIP/Postal Code
^required

installer_id

_string^query

Installer ID
^required^{only for installer order}

Single Tire Response example

Code Block

language	json

{
    "data": {
        "items": [
            {
                "tires": [
                    {
                        "tire_id": "UHJpbnh8fDM0MzEyNTA3MDN8fHRpcmVodWJkcm9wc2hpcHx8MTI4OTV8fEI=",
                        "part_number": "PX 3431250703",
                        "brand": "Prinx",
                        "price": 69.99,
                        "retail_price": 69.99,
                        "quantity": 1,
                        "fet": null,
                        "delivery_fee": null,
                        "delivery_date_time": {
                            "date": "2023-10-12",
                            "time": "17:00:00",
                            "timezone": "-04:00"
                        }
                    }
                ],
                "order_total": {
                    "delivery_fee": 7.55,
                    "fet": 0,
                    "total_price": 77.54
                },
                "delivery_date_time": {
                    "date": "2023-10-12",
                    "time": "17:00:00",
                    "timezone": "-04:00"
                }
            }
        ]
    }
}

Multi Tire Response example

Code Block

language	json

{
    "data": {
        "items": [
            {
                "tires": [
                    {
                        "tire_id": "UHJpbnh8fDM0MzEyNTA3MDN8fHRpcmVodWJkcm9wc2hpcHx8MTI4OTV8fEI=",
                        "part_number": "PX 3431250703",
                        "brand": "Prinx",
                        "price": 69.99,
                        "retail_price": 69.99,
                        "quantity": 1,
                        "fet": null,
                        "delivery_fee": null,
                        "delivery_date_time": {
                            "date": "2023-10-12",
                            "time": "17:00:00",
                            "timezone": "-04:00"
                        }
                    },
                    {
                        "tire_id": "QnJpZGdlc3RvbmV8fDA1MzkxNnx8dGlyZWh1YmRyb3BzaGlwfHwxMjg5NXx8Qg==",
                        "part_number": "BR 053916",
                        "brand": "Bridgestone",
                        "price": 62.99,
                        "retail_price": 62.99,
                        "quantity": 1,
                        "fet": null,
                        "delivery_fee": null,
                        "delivery_date_time": {
                            "date": "2023-10-12",
                            "time": "17:00:00",
                            "timezone": "-04:00"
                        }
                    }
                ],
                "order_total": {
                    "delivery_fee": 14.85,
                    "fet": 0,
                    "total_price": 147.83
                },
                "delivery_date_time": {
                    "date": "2023-10-12",
                    "time": "17:00:00",
                    "timezone": "-04:00"
                }
            }
        ]
    }
}

Response Parameters

tire_id ^string	Tire ID
part_number ^string	Tire part number
brand ^string	Tire Brand
price ^int	Tire cost
retail_price ^int	Tire retail price
quantity ^int	Requested quantity
fet ^int	FET
tires.delivery_fee ^int	Delivery fee of each tire. Can be null in case supplier won’t return it per tire
tires.delivery_date_time ^array	Delivery Date & Time for each tire
date ^string	Delivery date for each tire
time ^string	Delivery time for each tire
timezone ^string	Timezone
order_total ^array	Prices for whole order
order_total.delivery_fee ^int	Delivery fee for whole order
order_total.fet ^int	FET for whole order
order_total.total_price ^int	Total price for whole order including delivery fee & FET
delivery_date_time ^array	Delivery Date & Time for whole order
date ^string	Delivery date for whole order
time ^string	Delivery time for whole order
timezone ^string	Timezone

Order Create

POST /api/supplier/dropship/order/create/

This methods are used for placing an orders.

Single Tire

Request Example

Code Block

curl --location 'https://devdemo.tireconnect.ca/api/supplier/dropship/order/create/installer?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJkZWFsZXJfbG9jYXRpb24iOjEyODk1LCJleHAiOjE2OTY0MjAyNDF9.gtzjRCerVbwJEaJ0fMxkR7JEbeKxbiDbB41GVaqzfBpvRSPiNUfNR6yAk2KgL5Uc6rQRKVKs0AM0bX6NSlFSykTPelUkKws0t45lYIBMEpX4Ig91R9TJ0OJOQmOe7QhdMHjmgGBjPKNfl3cwAUWlzD9cOcqXNn68aFajh8exCDM' \
--header 'Content-Type: application/json' \
--data '{
  "location_id": 12895,
  "tires": [
    {
      "tire_id": "UHJpbnh8fDM0MzEyNTA3MDN8fHRpcmVodWJkcm9wc2hpcHx8MTI4OTV8fEI=",
      "quantity": 1
    }
  ],
  "delivery_address": {
    "address_line_1": "311 Madison Street",
    "address_line_2": "string",
    "city": "Oak Park",
    "province": "IL",
    "country": "US",
    "postal_code": 11207
  },
  "contact": {
    "name": "John Smith",
    "phone": "416-666-8786"
  },
  "po_number": "PO1234-TR56",
  "installer_id": "123456"
}'

Multi Tire

Request Example

Code Block

curl --location 'https://devdemo.tireconnect.ca/api/supplier/dropship/order/create/installer?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJkZWFsZXJfbG9jYXRpb24iOjEyODk1LCJleHAiOjE2OTY0MjI0ODN9.ArHo9GXl_ZrOeN4u9BJKr6N9X3Lzqh_OMSEJg0eMEea7s_laGIk_4vLvthAq1y8swKU1Cc-UHHv43y69tbSh2b62a9lXIM88JdTcMU88ZOfwYbZqtO3VVWQtMPI9eWKH8aPPJPT1r-GLGtjRakyQF1qwPJZK5salFS0kNlSea24' \
--header 'Content-Type: application/json' \
--data '{
  "location_id": 12895,
  "tires": [
    {
      "tire_id": "UHJpbnh8fDM0MzEyNTA3MDN8fHRpcmVodWJkcm9wc2hpcHx8MTI4OTV8fEI=",
      "quantity": 1
    },
    {
      "tire_id": "QnJpZGdlc3RvbmV8fDA1MzkxNnx8dGlyZWh1YmRyb3BzaGlwfHwxMjg5NXx8Qg==",
      "quantity": 1
    }
  ],
  "delivery_address": {
    "address_line_1": "311 Madison Street",
    "address_line_2": "string",
    "city": "Oak Park",
    "province": "IL",
    "country": "US",
    "postal_code": 11207
  },
  "contact": {
    "name": "John Smith",
    "phone": "416-666-8786"
  },
  "po_number": "PO1234-TR56",
  "installer_id": "123456"
}'

Request parameters

token

^query

Authorisation token

^required

tire_id

_string

Tire ID

^required

quantity

^int

Tire Quantity
^required

address_line_1

_string

Address Line 1
^required

address_line_2
^string

Address Line 2
^optional

city

_string

City
^required

province

_string

Province
^required

country

_string

Country
^required

postal_code

_string

ZIP/Postal Code
^required

name

_string

Contact name

^required

phone

_string

Contact phone

^required

po_number

_string

Order PO Number

^required

installer_id

_string

Installer ID
^required^{only for installer order}

Single Tire Response example

Code Block

language	json

{
    "data": {
        "items": [
            {
                "id": 15694,
                "status": "Successful",
                "po_number": "PO1234-TR56",
                "reference_number": "16937631",
                "tires": [
                    {
                        "tire_id": "UHJpbnh8fDM0MzEyNTA3MDN8fFRIRFN8fDEyODk1",
                        "part_number": "PX 3431250703",
                        "brand": "Prinx",
                        "price": 69.99,
                        "retail_price": 79.99,
                        "quantity": 1,
                        "fet": 0,
                        "delivery_fee": null,
                        "delivery_date_time": {
                            "date": "2023-10-05",
                            "time": "17:00:00",
                            "timezone": "-04:00"
                        }
                    }
                ],
                "order_total": {
                    "delivery_fee": 33.8,
                    "fet": null,
                    "total_price": 166.78
                },
                "delivery_date_time": {
                    "date": "2023-10-05",
                    "time": "17:00:00",
                    "timezone": "-04:00"
                }
            }
        ]
    }
}

Multi Tire Response example

Code Block

language	json

{
    "data": {
        "items": [
            {
                "id": 15694,
                "status": "Successful",
                "po_number": "PO1234-TR56",
                "reference_number": "16937631",
                "tires": [
                    {
                        "tire_id": "UHJpbnh8fDM0MzEyNTA3MDN8fFRIRFN8fDEyODk1",
                        "part_number": "PX 3431250703",
                        "brand": "Prinx",
                        "price": 69.99,
                        "retail_price": 79.99,
                        "quantity": 1,
                        "fet": 0,
                        "delivery_fee": null,
                        "delivery_date_time": {
                            "date": "2023-10-05",
                            "time": "17:00:00",
                            "timezone": "-04:00"
                        }
                    },
                    {
                        "tire_id": "QnJpZGdlc3RvbmV8fDA1MzkxNnx8VEhEU3x8MTI4OTU=",
                        "part_number": "BR 053916",
                        "brand": "Bridgestone",
                        "price": 62.99,
                        "retail_price": 72.99,
                        "quantity": 1,
                        "fet": 0,
                        "delivery_fee": null,
                        "delivery_date_time": {
                            "date": "2023-10-05",
                            "time": "17:00:00",
                            "timezone": "-04:00"
                        }
                    }
                ],
                "order_total": {
                    "delivery_fee": 33.8,
                    "fet": null,
                    "total_price": 166.78
                },
                "delivery_date_time": {
                    "date": "2023-10-05",
                    "time": "17:00:00",
                    "timezone": "-04:00"
                }
            }
        ]
    }
}

Response Parameters

id ^int	Order ID
status ^string	Order Status
po_number ^string	Order PO Number (provided by customer)
reference_number ^string	Order Reference Number (provided by supplier)
tire_id ^string	Tire ID
part_number ^string	Tire part number
brand ^string	Tire Brand
price ^int	Tire cost
retail_price ^int	Tire retail price
quantity ^int	Requested quantity
fet ^int	FET
tires.delivery_fee ^int	Delivery fee of each tire. Can be null in case supplier won’t return it per tire
tires.delivery_date_time ^array	Delivery Date & Time for each tire
date ^string	Delivery date for each tire
time ^string	Delivery time for each tire
timezone ^string	Timezone
order_total ^array	Prices for whole order
order_total.delivery_fee ^int	Delivery fee for whole order
order_total.fet ^int	FET for whole order
order_total.total_price ^int	Total price for whole order including delivery fee & FET
delivery_date_time ^array	Delivery Date & Time for whole order
date ^string	Delivery date for whole order
time ^string	Delivery time for whole order
timezone ^string	Timezone

Order Status

POST /api/supplier/dropship/order/status

This method used for receiving order status from the supplier.

Request Example

Code Block

curl --location 'https://devdemo.tireconnect.ca/api/supplier/dropship/order/status?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJkZWFsZXJfbG9jYXRpb24iOjEyODk1LCJleHAiOjE2OTY0MjI0ODN9.ArHo9GXl_ZrOeN4u9BJKr6N9X3Lzqh_OMSEJg0eMEea7s_laGIk_4vLvthAq1y8swKU1Cc-UHHv43y69tbSh2b62a9lXIM88JdTcMU88ZOfwYbZqtO3VVWQtMPI9eWKH8aPPJPT1r-GLGtjRakyQF1qwPJZK5salFS0kNlSea24' \
--header 'Content-Type: application/json' \
--data '{
  "location_id": 12895,
  "id": 10471
}'

Request parameters

token
^query

Authorisation token

^required

location_id
^int

Location ID which was used for placing an order

id
^int

Order ID

Response Example

Code Block

language	json

{
    "data": {
        "items": [
            {
                "order_id": 10471,
                "status": "Successful",
                "vendor_status": "Approved"
            }
        ]
    }
}

Response parameters

order_id ^int	Order ID
status ^int	Order Status in TC system
vendor_status ^int	Order Status in Vendor system

Ordering restrictions

In one order can’t be placed tires from different suppliers. In this case it should be several different orders:

Code Block

language	json

{
    "success": false,
    "status": 400,
    "error_code": 400099,
    "message": "All tires must belong to the same supplier",
    "errors": null
}

In one order can’t be placed more than four sku:

Code Block

language	json

{
    "success": false,
    "status": 400,
    "error_code": 400100,
    "message": "Max tires exceeded, 4 tires allowed.",
    "errors": null
}

...

Versions Compared

Old Version 4

New Version 5

Key

Order Create

Single Tire

Multi Tire

Order Status

Ordering restrictions

Page Comparison

Versions Compared

Old Version 4

New Version 5

Key

Order Create

Single Tire

Multi Tire

Order Status

Ordering restrictions