Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

...

Code Block
languagenone
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_e7IUfVin2sCBDYpNBPHhO8c' \
--header 'Content-Type: application/json' \
--data '{
  "location_id": 7359,
  "filter": {
}eyJwYXJ0bmVyIjoiM2I5YzM3N2YtOGJlNi00NjljLWI0MGEtM2ZkMzg1ZDMzZTIxIiwiZXhwIjoxNzIwNTIxNzAwfQ.BlXxKXe5wT3TEtynlFNaPdcpUs82l1ZXTIO7fRmy-KyZrpHHTUbLW3oG3HWucvz0ZzhMTxm-XffCky5A2bjmYo1oCDPPYjfOeuI1vT-ddhSgtnsnXZacfuBK_2E0lSktTdQNllUZB14VGqCcv0vVSJ567_CFT6WaguSjBaYRK40' \
--header 'Content-Type: application/json' \
--data '{
   "location_id":1,
   "filter":{
      "status":[
         "approve",
         "pending",
         "reject"
      ],
      "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
int

Location id

required

filter
object

An object of filters

Available values:
filter
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

...