Skip to main content
GET
Delivers the synchronisation settings configured for a single connector account, one entry per synchronizable object type.

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 whose synchronisation settings are retrieved (composite id, ADR-69), tenant-local, not a UUID.

Response

Success.

entityType
enum<integer>
required

The synchronized object type these settings apply to. It identifies the entry within the connector; the internal surrogate key of the underlying row is not exposed.

Available options:
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59,
60,
61,
62,
63,
64,
65,
66,
67,
68,
69,
70,
71,
72,
73,
74,
75,
76,
77,
78,
79,
80,
81,
82,
83,
84,
85,
86,
87,
88,
89,
90,
91,
92
canDelete
boolean
required

Connector is allowed to delete this object type. Never null - the underlying column is NOT NULL DEFAULT 0.

canSend
boolean

Connector is allowed to send this object type. Null (GraphQL) or omitted (REST) if that has never been configured - deliberately distinct from false: "never configured" is not the same statement as "configured as not allowed".

canReceive
boolean

Connector is allowed to receive this object type. Null (GraphQL) or omitted (REST) if that has never been configured - deliberately distinct from false, as for CanSend.