...

Code Block

language	json

{
    "data": [
        {
            "logo": "https://devdemo.tireconnect.ca/uploads/supplier/f386424d92a6d6982243f085b841f11f43c81132.jpg",
            "name": "ATD/NTD",
            "id": "ATD",
            "operating_countries": [
                "CA",
                "US"
            ],
            "operating_regions": [
                {
                    "country": "CA",
                    "states": [
                        "AB",
                        "MB",
                        "NL"
                    ]
                },
                {
                    "country": "US",
                    "states": [
                        "WA"
                    ]
                }
            ],
            "tf": true,
            "ordering_supported": true,
            "contact_phone": "3312342343",
            "address": {
                "address_line_1": "67 Rue Wellington",
                "address_line_2": null,
                "city": "Gatineau",
                "postal_code": "J8X 2H4",
                "state": "QC",
                "country": "CA"
            },
            "credentials": [
                {
                    "type": "input",
                    "mapping": "location:location_number",
                    "options": null,
                    "name": "location_number",
                    "label": "Location number",
                    "description": "Location number in ATD system",
                    "required": true,
                    "link": null,
                    "is_checked": false,
                    "attributes": [
                        {
                            "name": "name",
                            "value": "location_number"
                        }
                    ]
                },
                {
                    "type": "select",
                    "mapping": "ordering:fillkill",
                    "options": [
                        "Fill or Kill",
                        "Fill and Kill"
                    ],
                    "name": "fill_kill",
                    "label": "Fill Kill",
                    "description": "Default ordering behaviour",
                    "required": false,
                    "link": null,
                    "is_checked": false,
                    "attributes": [
                        {
                            "name": "name",
                            "value": "fill_kill"
                        }
                    ]
                },
                {
                    "type": "input",
                    "mapping": null,
                    "options": null,
                    "name": "account_number",
                    "label": "Account Number",
                    "description": "Account number in ATD system",
                    "required": true,
                    "link": null,
                    "is_checked": false,
                    "attributes": [
                        {
                            "name": "name",
                            "value": "account_number"
                        }
                    ]
                },
                {
                    "type": "input",
                    "mappingoptions": "common:username"null,
                    "optionsname": null"username",
                    "namelabel": "usernameUsername",
                    "labeldescription": "UsernameUser Login(s)",
                    "descriptionrequired": "User Login(s)",
                    "required": true,
                    "link": null,
                    "is_checked": false,
                    "attributes": [
                        {
                            "name": "name",
                            "value": "username"
                        }
                    ]
                },
                {
                    "type": "checkbox",
                    "mapping": "ordering:always_default_delivery",
                    "options": null,
                    "name": "ADD",
                    "label": "ADD",
                    "description": "Defualt Delivery Option",
                    "required": true,
                    "link": null,
                    "is_checked": true,
                    "attributes": [
                        {
                            "name": "name",
                            "value": "ADD"
                        },
                        {
                            "name": "checked",
                            "value": "checked"
                        }
                    ]
                }
            ]
        }
    ],
    "meta": {
        "total": 1
    }
}

...

mapping
^string

logo ^string	Supplier’s logo
name ^string	Supplier name
id ^int	Supplier connection ID
operating_countries ^array	List of supplier operating countries ^deprecated
operating_countries ^array	List of supplier countries with regions where supplier operating
country ^string	Country
states ^string	List of states
tf ^boolean	Transaction Fee
ordering_supported ^string	Mark of direct ordering support
contact_phone ^string	Supplier contact phone
address ^object	Supplier address
address_line_1 ^string	Address line 1
address_line_2 ^string	Address line 2
city ^string	City
postal_code ^string	Zip/postal code
state ^string	State/province
country ^string	Country
credentials ^object	Object with credentials needed for supplier connection request
type ^string	Field type
options ^string	Available options to select
name ^string	Field name
label ^string	Field label
description ^string	Field description
required ^boolean	Field required or not
link ^string	Link to supplier registration form
is_checked ^boolean	In case field_type = checkbox it will show it’s initial state
attributes ^array	Field attributes

...

Code Block

curl --location 'https://devdemo.tireconnect.ca/api/account/v2/client/dealer/language/updatecreate' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwYXJ0bmVyIjoiNmFhNzJlODMtNjkzMS00YjBiLTkyY2UtYWMxODg5YTIyNjgwIiwiZXhwIjoxNzE2Mzk0NTA1fQ.g8wCD3Fh3Kd9UWVxXYx8I0y_m54EPD-wQcgh9ugW3HUqYrxiXsLR5PZfC3QCZhl0Tw676ukAInQc2LEZ3bpvf_XKFWXnAOGGZOdXB1YP8qkBRs_3Ci-G9uv317Uiy933XXd-QaQgMSUKsUg10EeZOkFqUzZlDXBXQ4ag4BTAfR0' \
--data '{
  "client_id": 260,
  "dealer_id": 12625,
  "locale": "fr_CA",
  "company_name": "Test Company"
}'

...

Request parameters

location_id
^int

Dealer Location id

^required

Response example

...

dealer_id ^int	Dealer id ^required
first_name ^string	First name ^required
last_name ^string	Last name ^required
email ^string	Location email ^required
additional_email ^array^string	Location additional email ^optional
phone_number ^string	Location phone number ^required
postal_code ^string	Location zip/postal code ^required
country ^string	Location country ^required
province ^string	Location province ^required
latitude ^decimal	Location latitude ^required
longitude ^decimal	Location longitude ^required
external_id ^string	Location external id ^optional
language ^array	Array with localised values for location ^required
locale ^string	Locale label ^required
location_name ^string	Location name ^required
address_line_1 ^string	Address line 1 ^required
address_line_2 ^string	Address line 2 ^optional
city ^string	Location city ^required
is_active ^boolean	Shows whether the location is active or not ^required

...

dealer_id
^int

Dealer id

^required

location_id
^int

Location id

^required

Connection requests

All methods in this section have the same response structure

...

Activate tire supplier connection

POST /account/v2/location/tire/connection/activate

This method allows you to activate dealer.

Request example

Code Block

language	json

{
   "success":true,
   "data":{
      "items":[
         {
            "connection_requestcurl --location 'https://devdemo.tireconnect.ca/api/account/v2/location/tire/connection/activate' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwYXJ0bmVyIjoiM2I5YzM3N2YtOGJlNi00NjljLWI0MGEtM2ZkMzg1ZDMzZTIxIiwiZXhwIjoxNzM0NTQ0ODg1fQ.cmN2qKr3lGaCszkI_IwWoNFDcYrbZ57MVa0OrvYsqHb230Gq5994Vi47i0BDrl-jyDXnAIEmCgKkxXjLJ1DK3Ay840o2OvUa4VEj_Wrg9sgDJABW8_pBp04LqjJJOEtt1ssacoV6TNfsH9NYi210bk38gO1aJX-e4ciHEbM6eRA' \
--data '{
  "location_id":1,
            "location_id":1,
            "contact_details":{
               "first_name":"John",
               "last_name":"Doe",
               "email":"john@doe.com",
               "phone":"1 888 792-7072"
  "supplier":"atd"
}'

Request parameters

location_id
^int

Location id

^required

supplier
^string

Supplier
Note: Can be found using Get list of tire suppliers connected to location method

^required

Deactivate tire supplier connection

POST /account/v2/location/tire/connection/deactivate

This method allows you to activate dealer.

Request example

Code Block

curl --location 'https://devdemo.tireconnect.ca/api/account/v2/location/tire/connection/deactivate' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwYXJ0bmVyIjoiM2I5YzM3N2YtOGJlNi00NjljLWI0MGEtM2ZkMzg1ZDMzZTIxIiwiZXhwIjoxNzM0NTQ0ODg1fQ.cmN2qKr3lGaCszkI_IwWoNFDcYrbZ57MVa0OrvYsqHb230Gq5994Vi47i0BDrl-jyDXnAIEmCgKkxXjLJ1DK3Ay840o2OvUa4VEj_Wrg9sgDJABW8_pBp04LqjJJOEtt1ssacoV6TNfsH9NYi210bk38gO1aJX-e4ciHEbM6eRA' \
--data '{
  "location_id":1,
  "supplier":"atd"
}'

Request parameters

location_id
^int

Location id

^required

supplier
^string

Supplier
Note: Can be found using Get list of tire suppliers connected to location method

^required

Connection requests

All methods in this section have the same response structure

Response example

Code Block

language	json

{
   "success":true,
   "data":{
      "items":[
         },{
            "supplierconnection_request_cidid":"ATD"1,
            "supplierlocation_nameid":"ATD/NTD"1,
            "credentialscontact_details":[{
               {
  "first_name":"John",
               "last_name":"location_numberDoe",
  
               "valueemail":"1john@doe.com",
               },
 "phone":"1 888 792-7072"
             {},
                  "name"supplier_cid":"fill_killATD",
                  "value"supplier_name":"Fill or Kill"ATD/NTD",
            "credentials":[
  },
               {
                  "name":"accountlocation_number",
                  "value":"31"
               },
               {
                  "name":"usernamefill_kill",
                  "value":"4Fill or Kill"
               },
               {
     ],             "statusname":"pendingaccount_number",
            "note":"Some note about   connection request" "value":"3"
               },
            "updated_at":"2021-09-08T04:31:24-04:00",   {
                  "name":"username",
                  "created_atvalue":"2021-01-26T11:56:17-05:00"4"
               }
      ]      }],
   "meta":{         "totalstatus":1"pending",
     }
}

Response Parameters

...

status
^string

...

Status

...

connection_request_id
^int

...

Connection request id

...

location_id
^int

...

Location id

...

contact_details
^object

...

Object with contact details

...

first_name
^string

...

First name

...

last_name
^string

...

Last name

...

email
^string

...

Email

...

phone
^string

...

Phone number

...

supplier_cid
^string

...

Supplier CID

...

supplier_name
^string

...

Supplier name

...

credentials
^object

...

Object with credentials needed to connect location to supplier

...

name
^string

...

Parameter name

...

value
^array

...

Parameter value

...

status
^string

...

Request status

...

note
^string

...

Some notes

...

updated_at
^string

...

Shows when request was updated last time

...

created_at
^boolean

...

Shows when request was created

Create connection request for tire supplier

POST /account/v2/location/connection-request/create

This method allows you to create supplier connection request.

Request example

Code Block

language	none

curl --location 'https://devdemo.tireconnect.ca/api/account/v2/connection-request/create' \
--header 'accept: application/json' \
--header 'token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwYXJ0bmVyIjoiNmFhNzJlODMtNjkzMS00YjBiLTkyY2UtYWMxODg5YTIyNjgwIiwiZXhwIjoxNzE2ODMwMjM5fQ.lzDKjnBlkPXPddNbhow0d_lQ8vPbnKQj9odYOv7eGwTnA1PEO0XPCdJJx8ZTAMepcGu2Kp1eq9fbYcrHw56v2X6Gp4oAxxHX8SE98g3-0gchoyH1-khv89WsVizHgLMC276l0fIYzUX8wkuo6H4UAhFCI_7oVJ9HLuMtFjyNVRw' \
--header 'Content-Type: application/json' \
--data-raw '{
   "supplier_cid":"ATD",
   "location_id":1,
   "first_name":"John",
   "last_name":"Doe",
   "email":"john@doe.com",
   "phone":"1 888 792-7072",
   "note":"Some note about connection request",
   "credentials":[
      {
         "name":"location_number",
         "value":"1"
      },
      {
         "name":"fill_kill",       "note":"Some note about connection request",
            "updated_at":"2021-09-08T04:31:24-04:00",
            "created_at":"2021-01-26T11:56:17-05:00"
         }
      ]
   },
   "meta": {
        "count": 2, //only for list method
        "total": 2,
        "offset": 0, //only for list method
        "limit": 100, //only for list method
        "sort_by": "connection_request_id", //only for list method
        "sort_how": "asc" //only for list method
    }
}

Response Parameters

status ^string	Status
connection_request_id ^int	Connection request id
location_id ^int	Location id
contact_details ^object	Object with contact details
first_name ^string	First name
last_name ^string	Last name
email ^string	Email
phone ^string	Phone number
supplier_cid ^string	Supplier CID
supplier_name ^string	Supplier name
credentials ^object	Object with credentials needed to connect location to supplier
name ^string	Parameter name
value ^array	Parameter value
status ^string	Request status
note ^string	Some notes
updated_at ^string	Shows when request was updated last time
created_at ^boolean	Shows when request was created

Create connection request for tire supplier

POST /account/v2/location/connection-request/create

This method allows you to create supplier connection request.

Request example

Code Block

language	none

curl --location 'https://devdemo.tireconnect.ca/api/account/v2/location/connection-request/create' \
--header 'accept: application/json' \
--header 'token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwYXJ0bmVyIjoiNmFhNzJlODMtNjkzMS00YjBiLTkyY2UtYWMxODg5YTIyNjgwIiwiZXhwIjoxNzE2ODMwMjM5fQ.lzDKjnBlkPXPddNbhow0d_lQ8vPbnKQj9odYOv7eGwTnA1PEO0XPCdJJx8ZTAMepcGu2Kp1eq9fbYcrHw56v2X6Gp4oAxxHX8SE98g3-0gchoyH1-khv89WsVizHgLMC276l0fIYzUX8wkuo6H4UAhFCI_7oVJ9HLuMtFjyNVRw' \
--header 'Content-Type: application/json' \
--data-raw '{
   "supplier_cid":"ATD",
   "location_id":1,
   "first_name":"John",
   "last_name":"Doe",
   "email":"john@doe.com",
   "phone":"1 888 792-7072",
   "note":"Some note about connection request",
   "credentials":[
      {
         "name":"location_number",
         "value":"1"
      },
      {
         "name":"fill_kill",
         "value":"Fill or Kill"
      },
      {
         "name":"account_number",
         "value":"3"
      },
      {
         "name":"username",
         "value":"4"
      }
   ]
}'

Request parameters

supplier_cid ^string	Supplier CID ^required
location_id ^int	Location id ^required
first_name ^string	First name ^required
last_name ^string	Last name ^required
email ^string	Email ^required
phone ^string	Phone number ^required
note ^string	Some notes ^optional
credentials ^array	Array with credentials needed to connect location to supplier ^required
name ^string	Parameter name ^required
value ^string	Parameter value ^required

Get list of connection requests

POST /account/v2/location/connection-request/list

This method allows you to get a list of all connection requests

Request example

Code Block

language	none

curl --location 'https://devdemo.tireconnect.ca/api/account/v2/location/connection-request/list' \
--header 'accept: application/json' \
--header 'token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwYXJ0bmVyIjoiM2I5YzM3N2YtOGJlNi00NjljLWI0MGEtM2ZkMzg1ZDMzZTIxIiwiZXhwIjoxNzIwNTIxNzAwfQ.BlXxKXe5wT3TEtynlFNaPdcpUs82l1ZXTIO7fRmy-KyZrpHHTUbLW3oG3HWucvz0ZzhMTxm-XffCky5A2bjmYo1oCDPPYjfOeuI1vT-ddhSgtnsnXZacfuBK_2E0lSktTdQNllUZB14VGqCcv0vVSJ567_CFT6WaguSjBaYRK40' \
--header 'Content-Type: application/json' \
--data '{
   "location_id":1,
   "filter":{
      "status":[
         "value":"Fill or Kill"approved",
         }"pending",
      {   "rejected"
      "name":"account_number"],
         "value":"3""connection_request_id":[
      },   1,
   {      2
   "name":"username",   ],
      "value":"4"
   created_at":{
  }    ]
}'

Request parameters

...

supplier_cid
^string

...

Supplier CID

^required

...

location_id
^int

...

Location id

^required

...

first_name
^string

...

First name

^required

...

last_name
^string

...

Last name

^required

...

email
^string

...

Email

^required

...

phone
^string

...

Phone number

^required

...

note
^string

...

Some notes

^optional

...

credentials
^array

...

Array with credentials needed to connect location to supplier

^required

...

name
^string

...

Parameter name

^required

...

value
^string

...

Parameter value

^required

Get list of connection requests

POST /account/v2/location/connection-request/list

This method allows you to get a list of all connection requests

Request example

Code Block

language	none

curl --location 'https://devdemo.tireconnect.ca/sf3_api_dev.php/api/account/v2/connection-request/list' \
--header 'accept: application/json' \
--header 'token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwYXJ0bmVyIjoiNmFhNzJlODMtNjkzMS00YjBiLTkyY2UtYWMxODg5YTIyNjgwIiwiZXhwIjoxNzE2ODk5NTE2fQ.bbskS2tAVean4fY0V5lohavytEErlOsXA_BD37nVezHhHXAMhhFdlJ3ZZi9TDLvmHHrrBWho_ymW-dppSrW2A6LY8s4s_rWEG4m6M4fkbeEibBns3-Iv6EWb0PNZdvCbje8U1ka-_KW352E8c6B_e7IUfVin2sCBDYpNBPHhO8c' \
--header 'Content-Type: application/json' \
--data '{
  "location_id": 7359,
  "filter": {
}
   "from":"2024-01-01 00:00:00",
         "to":"2025-01-01 23:59:59"
      },
      "updated_at":{
         "from":"2024-01-01 00:00:00",
         "to":"2025-01-01 23:59:59"
      }
   },
   "limit":10,
   "offset":0,
   "sort_by":"created_at",
   "sort_how":"desc"
}'

Request parameters

location_id ^int	Location id ^required
filter ^object	An object of filters Available values: status connection_request_id created_at updated_at ^optional
limit ^int	Limit ^optional
offset ^int	Offset ^optional
sort_by ^string	Sort by ^optional
sort_how ^string	Sort how ^optional

Cancel connection request

...

connection_request_id ^int	Connection request id ^required
location_id ^int	Location id ^required
first_name ^string	First Name ^optional
last_name ^string	Last name ^optional
email ^string	Email ^optional
phone ^string	Phone number ^optional
note ^string	Some notes ^optional
credentials ^array	Object with credentials needed to connect location to supplier. In case nothing should be changed it can be empty array ^optional
name ^string	Parameter name ^required
value ^string	Parameter value ^required