...
Get started
Please make sure you are using DEV environment base URL:
| Code Block |
|---|
https://devdemo.tireconnect.ca |
Get authorisation token
POST /api/partner/auth/
For all methods listed below you will need to use a token. Please note that you should use token in header as token.
...
token | Authorisation token |
|---|---|
expire | expire time |
Get list of available clients
POST /api/account/v2/partner/client/list
...
status | Status |
|---|---|
client_id | Client’s ID |
client_name | Client Name |
access_type |
|
Get list of available suppliers
GET /api/partner/supplier
This method will return all available suppliers that can be connected to dealer location.
...
logo | Supplier’s logo |
|---|---|
name | Supplier name |
id | Supplier connection ID |
operating_countries | List of supplier operating countries |
operating_countries | List of supplier countries with regions where supplier operating |
country | Country |
states | List of states |
tf | Transaction Fee |
ordering_supported | Mark of direct ordering support |
contact_phone | Supplier contact phone |
address | Supplier address |
address_line_1 | Address line 1 |
address_line_2 | Address line 2 |
city | City |
postal_code | Zip/postal code |
state | State/province |
country | Country |
credentials | Object with credentials needed for supplier connection request |
type | Field type |
mapping | |
options | Available options to select |
name | Field name |
label | Field label |
description | Field description |
required | Field required or not |
link | Link to supplier registration form |
is_checked | In case field_type = checkbox it will show it’s initial state |
attributes | Field attributes |
Get list of locales for client
POST account/v2/client/locale/list
...
status | Status |
|---|---|
locale | Locale label |
default | Shows if this locale default or not |
Dealer management methods
All methods in this section have the same response structure
...
status | Status |
|---|---|
dealer_id | Dealer ID |
first_name | First Name |
last_name | Last Name |
email | |
additional_emails | List of additional emails |
phone_number | Phone Number |
fax | Fax |
group | Group |
language | Array with localised values for dealer |
locale | Locale label |
company_name | Dealer’s Name |
logo | Dealer’s Logo |
is_active | Shows whether the dealer is active or not |
updated_at | Shows when dealer was updated last time |
created_at | Shows when dealer was created |
Get list of dealers for specified client
POST /account/v2/client/dealer/list
...
client_id | Client ID required |
|---|
Create dealer
POST /account/v2/client/dealer/create
...
client_id | Client id required |
|---|---|
first_name | Dealer first name required |
last_name | Dealer last name required |
email | Dealer email required |
additional_emails | Array of dealer additional emails optional |
phone_number | Dealer phone number required |
fax | Dealer fax optional |
language | List of localised items required |
locale | Locale label required |
company_name | Dealer name required |
is_active | Shows whether the dealer is active or not optional |
Update dealer
POST /account/v2/client/dealer/update
...
client_id | Client id required |
|---|---|
dealer_id | Dealer id required |
first_name | Dealer first name optional |
last_name | Dealer last name optional |
email | Dealer email optional |
additional_emails | Array of dealer additional emails optional |
phone_number | Dealer phone number optional |
fax | Dealer fax optional |
is_active | Shows whether the dealer is active or not optional |
Update dealer localised values
POST /account/v2/client/dealer/language/update
...
client_id | Client id required |
|---|---|
dealer_id | Dealer id required |
locale | Locale label required |
company_name | Dealer company name optional |
Add dealer localised values
POST /account/v2/client/dealer/language/create
...
client_id | Client id required |
|---|---|
dealer_id | Dealer id required |
locale | Locale label required |
company_name | Dealer company name required |
Activate dealer
POST /account/v2/client/dealer/activate
...
client_id | Client id required |
|---|---|
dealer_id | Dealer id required |
Deactivate dealer
POST /account/v2/client/dealer/deactivate
...
client_id | Client id required |
|---|---|
dealer_id | Dealer id required |
Dealer location management methods
All methods in this section have the same response structure
...
status | Status |
|---|---|
location_id | Location id |
first_name | First name |
last_name | Last name |
email | Location email |
additional_email | Location additional email |
phone_number | Location phone number |
postal_code | Location zip/postal code |
country | Location country |
province | Location province |
latitude | Location latitude |
longitude | Location longitude |
external_id | Location external id |
language | Array with localised values for location |
locale | Locale label |
location_name | Location name |
address_line_1 | Address line 1 |
address_line_2 | Address line 2 |
city | Location city |
is_active | Shows whether the location is active or not |
updated_at | Shows when location was updated last time |
created_at | Shows when location was created |
Get list of dealer locations
POST /account/v2/dealer/location/list
...
dealer_id | Dealer id required |
|---|
Get list of tire suppliers connected to location
POST /account/v2/location/tire/connection/list
...
status | Status |
|---|---|
supplier_cid | Supplier connection id |
supplier | Supplier id |
supplier_name | Supplier nice name |
Create location
POST /account/v2/dealer/location/create
...
dealer_id | Dealer id required |
|---|---|
first_name | First name required |
last_name | Last name required |
email | Location email required |
additional_email | Location additional email optional |
phone_number | Location phone number required |
postal_code | Location zip/postal code required |
country | Location country required |
province | Location province required |
latitude | Location latitude required |
longitude | Location longitude required |
external_id | Location external id optional |
language | Array with localised values for location required |
locale | Locale label required |
location_name | Location name required |
address_line_1 | Address line 1 required |
address_line_2 | Address line 2 optional |
city | Location city required |
is_active | Shows whether the location is active or not required |
Update location
POST /account/v2/dealer/location/update
...
dealer_id | Dealer id required |
|---|---|
location_id | Location id required |
first_name | First name optional |
last_name | Last name optional |
email | Location email optional |
additional_email | Location additional email optional |
phone_number | Location phone number optional |
postal_code | Location zip/postal code optional |
country | Location country optional |
province | Location province optional |
latitude | Location latitude optional |
longitude | Location longitude optional |
external_id | Location external id optional |
is_active | Shows whether the location is active or not optional |
Update location localised values
POST /account/v2/dealer/location/language/update
...
dealer_id | Client id required |
|---|---|
location_id | Dealer id required |
locale | Locale label required |
location_name | Dealer company name optional |
address_line_1 | Address line 1 optional |
address_line_2 | Address line 2 optional |
city | Location city optional |
Add location localised values
POST /account/v2/dealer/location/language/create
...
dealer_id | Client id required |
|---|---|
location_id | Dealer id required |
locale | Locale label required |
location_name | Dealer company name required |
address_line_1 | Address line 1 required |
address_line_2 | Address line 2 optional |
city | Location city required |
Activate location
POST /account/v2/dealer/location/activate
...
dealer_id | Dealer id required |
|---|---|
location_id | Location id required |
Deactivate location
POST /account/v2/dealer/location/deactivate
...
dealer_id | Dealer id required |
|---|---|
location_id | Location id required |
Connection requests
All methods in this section have the same response structure
...
status | Status |
|---|---|
connection_request_id | Connection request id |
location_id | Location id |
contact_details | Object with contact details |
first_name | First name |
last_name | Last name |
email | |
phone | Phone number |
supplier_cid | Supplier CID |
supplier_name | Supplier name |
credentials | Object with credentials needed to connect location to supplier |
name | Parameter name |
value | Parameter value |
status | Request status |
note | Some notes |
updated_at | Shows when request was updated last time |
created_at | Shows when request was created |
Create connection request for tire supplier
POST /account/v2/location/connection-request/create
...
supplier_cid | Supplier CID required |
|---|---|
location_id | Location id required |
first_name | First name required |
last_name | Last name required |
email | required |
phone | Phone number required |
note | Some notes optional |
credentials | Array with credentials needed to connect location to supplier required |
name | Parameter name required |
value | Parameter value required |
Get list of connection requests
POST /account/v2/location/connection-request/list
...
location_id | Location id required |
|---|---|
filter | An object of filters optional |
Cancel connection request
POST /account/v2/location/connection-request/cancel
...
supplier_cid | Supplier CID required |
|---|---|
location_id | Location id required |
connection_request_id | Connection request id required |
note | Some notes optional |
Resubmit connection request
POST /account/v2/location/connection-request/resubmit
...
connection_request_id | Connection request id required |
|---|---|
location_id | Location id required |
first_name | First Name optional |
last_name | Last name optional |
email | optional |
phone | Phone number optional |
note | Some notes optional |
credentials | Object with credentials needed to connect location to supplier. In case nothing should be changed it can be empty array optional |
name | Parameter name required |
value | Parameter value required |
Connection requests statuses
List of statuses
Pending (pending) - initial status, applied when connection request created or resubmitted
Rejected (rejected) - connection request was rejected due to some reason
On hold (on_hold) - connection request was putted on hold
Approved (approved) - connection request approved by the supplier, but it should be validated.
Auto Approved (auto_approved) - same as
approvedstatus.Cancelled (cancelled) - connection request was cancelled by the user.
In progress (in_progress) - validation of the connection.
Invalid (invalid) - validation failed, connection requires some action from the supplier.
Finalized (finalized) - connection created and validation passed.
Actions that can be done by the API user
Connection request creation → Pending: User created CR (location/connection-request/create)
...
Rejected → Pending: User resubmitted CR (location/connection-request/resubmit)
Supplier direct ordering
Get a token for direct ordering using Partner’s token
POST /location/auth/token
This method allows you to get token for direct ordering just with location_id and partner’s token.
...