Skip to main content
GET
Delivers a single connector account by its sales channel id.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Path Parameters

salesChannelId
string
required

Sales channel id of the connector account to retrieve (composite id, ADR-69), tenant-local, not a UUID.

Response

Success.

A single connector account, i.e. an online shop whose synchronisation is handled by JTL-Connector.

salesChannelId
string
required

Sales channel id of this connector account. A tenant-local, composite identifier, not a UUID. Use this to address the account in follow-up calls.

isActive
boolean
required

Connector account is active.

isLocked
boolean
required

Connector account is locked.

name
string

Name of the connector account.

url
string

URL of the connector endpoint.

companyId
string<uuid>

ID of the company the connector account belongs to.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"