Skip to main content
GET
Query Connector Synchronisation Settings

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 synchronization settings are retrieved. Opaque, tenant-local composite identifier (not a UUID); use the value returned by a sales channel listing.

Response

Success.

entityType
enum<integer>
required

The object type these settings apply to. Unique within a connector account.

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; defaults to false.

canSend
boolean

Connector is allowed to send this object type. Null (GraphQL) or omitted (REST) if never configured; not the same as false.

canReceive
boolean

Connector is allowed to receive this object type. Null (GraphQL) or omitted (REST) if never configured; not the same as false.