Get the current connection

GET

/connection

const url = 'https://sandbox.partners.loops.sa/v1/connection';
const options = {
  method: 'GET',
  headers: {'Loops-Merchant-Id': 'mer_7Hq2Lw8Z', Authorization: 'Bearer <token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://sandbox.partners.loops.sa/v1/connection \
  --header 'Authorization: Bearer <token>' \
  --header 'Loops-Merchant-Id: mer_7Hq2Lw8Z'

Returns what the merchant granted your application, including scopes and locations.

Authorizations

bearerAuth

Parameters

Header Parameters

Loops-Merchant-Id

string

The merchant you are acting for (mer_…). Required for platform applications; optional for direct integrations, which have a single merchant.

Responses

200

The connection.

application/json

object

required

string

merchant_id

required

string

external_ref

Your own reference for this merchant, if you provided one.

string | null

status

required

string

Allowed values: active revoked

scopes

required

Array<string>

location_ids

required

Array<string>

include_future_locations

Whether locations the merchant adds later are shared automatically.

boolean

created_at

required

string format: date-time

Example

{
  "id": "con_4Tz8Yp1W",
  "merchant_id": "mer_7Hq2Lw8Z",
  "external_ref": "BRQ-10021",
  "status": "active",
  "scopes": [
    "locations:read",
    "orders:read",
    "events:read"
  ]
}

401

The access token is missing, expired or invalid.

application/problem+json

RFC 9457 Problem Details with a stable code.

object

type

required

string format: uri

title

required

string

status

required

integer

code

required

Stable machine-readable error code. Switch on this, not on title.

string

Allowed values: invalid_request merchant_required unauthorized insufficient_scope scope_not_granted connection_not_active application_suspended channel_not_permitted not_found merchant_not_found rate_limited upstream_unavailable

detail

string

request_id

required

string

errors

Field errors, for invalid_request.

Array<object>

object

field

string

message

string

Example

{
  "type": "https://docs.partners.loops.sa/errors/scope_not_granted",
  "title": "Scope not granted",
  "status": 403,
  "code": "invalid_request",
  "detail": "The merchant has not granted orders:read to this application.",
  "request_id": "req_01J9X7P2QK"
}

403

Not allowed: the scope isn’t approved or granted, the connection is not active, or your application is suspended. See code.

application/problem+json

RFC 9457 Problem Details with a stable code.

object

type

required

string format: uri

title

required

string

status

required

integer

code

required

Stable machine-readable error code. Switch on this, not on title.

string

detail

string

request_id

required

string

errors

Field errors, for invalid_request.

Array<object>

object

field

string

message

string

Example

{
  "type": "https://docs.partners.loops.sa/errors/scope_not_granted",
  "title": "Scope not granted",
  "status": 403,
  "code": "invalid_request",
  "detail": "The merchant has not granted orders:read to this application.",
  "request_id": "req_01J9X7P2QK"
}