...
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 |
...
Code Block | ||
---|---|---|
| ||
{ "success":true, "data":{ "items":[ { "connection_request_id":1, "location_id":1, "contact_details":{ "first_name":"John", "last_name":"Doe", "email":"john@doe.com", "phone":"1 888 792-7072" }, "supplier_cid":"ATD", "supplier_name":"ATD/NTD", "credentials":[ { "name":"location_number", "value":"1" }, { "name":"fill_kill", "value":"Fill or Kill" }, { "name":"account_number", "value":"3" }, { "name":"username", "value":"4" } ], "status":"pending", "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"total":1: 2, //only for list method "total": 2, "offset": 0, //only for list method "limit": 100, //only for list method } } |
Response Parameters
...
status
string
...
Status
"sort_by": "connection_request_id |
...
Connection request id
", //only for list method
"sort_how": "asc" //only for list method
}
} |
Response Parameters
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 |
...
Code Block | ||
---|---|---|
| ||
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"
}
]
}' |
...
Code Block | ||
---|---|---|
| ||
curl --location 'https://devdemo.tireconnect.ca/sf3_api_dev.php/api/account/v2/location/connection-request/list' \ --header 'accept: application/json' \ --header 'token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwYXJ0bmVyIjoiNmFhNzJlODMtNjkzMS00YjBiLTkyY2UtYWMxODg5YTIyNjgwIiwiZXhwIjoxNzE2ODk5NTE2fQ.bbskS2tAVean4fY0V5lohavytEErlOsXA_BD37nVezHhHXAMhhFdlJ3ZZi9TDLvmHHrrBWho_ymW-dppSrW2A6LY8s4s_rWEG4m6M4fkbeEibBns3-Iv6EWb0PNZdvCbje8U1ka-_KW352E8c6B_e7IUfVin2sCBDYpNBPHhO8ceyJwYXJ0bmVyIjoiM2I5YzM3N2YtOGJlNi00NjljLWI0MGEtM2ZkMzg1ZDMzZTIxIiwiZXhwIjoxNzIwNTIxNzAwfQ.BlXxKXe5wT3TEtynlFNaPdcpUs82l1ZXTIO7fRmy-KyZrpHHTUbLW3oG3HWucvz0ZzhMTxm-XffCky5A2bjmYo1oCDPPYjfOeuI1vT-ddhSgtnsnXZacfuBK_2E0lSktTdQNllUZB14VGqCcv0vVSJ567_CFT6WaguSjBaYRK40' \ --header 'Content-Type: application/json' \ --data '{ "location_id": 7359, "filter": { }data '{ "location_id":1, "filter":{ "status":[ "approved", "pending", "rejected" ], "connection_request_id":[ 1, 2 ], "created_at":{ "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 | Location id required |
---|---|
filter | An object of filters Available values: optional |
limit | Limit optional |
offset | Offset optional |
sort_by | Sort by optional |
sort_how | Sort how optional |
Cancel connection request
...
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 request creation → Pending: User created CR (location/connection-request/create)
Pending → Pending: User edited CR (location/connection-request/resubmit)
Pending → Cancelled: User cancelled CR (location/connection-request/cancel)
...