> ## Documentation Index
> Fetch the complete documentation index at: https://developer.jtl-software.com/llms.txt
> Use this file to discover all available pages before exploring further.

# WorkerSync

> One sync of the worker: what it syncs, how often, and what it is doing. The API answers for one tenant, so only the syncs of that tenant appear.



**Kind**: `object`

## Fields

**`id`**: `ID!`

The ID of the sync.

---

**`type`**: `String!`

The key of the sync type, for example shop or ebay.

---

**`typeName`**: `String!`

The name of the sync type in the language of the caller.

---

**`targetName`**: `String`

What the sync talks to, for example the name of the shop or the marketplace account.

---

**`salesChannelId`**: `ID!`

The sales channel of the sync. Absent when it has none.

---

**`intervalSeconds`**: `Int!`

The pause between the end of a run and the start of the next, in seconds.

---

**`minimumIntervalSeconds`**: `Int!`

The shortest allowed interval, in seconds.

---

**`defaultIntervalSeconds`**: `Int!`

The interval the sync starts with, in seconds.

---

**`isControllable`**: `Boolean!`

Whether a user can start and stop the sync.

---

**`requiredLicenseId`**: `String`

The key of the license the sync type needs (wms, productionPlanning, wmsAutostore). Absent for a type without a license requirement. Derived from the checks the clients make today (assumption, there is no central license check per sync).

---

**`isLicensed`**: `Boolean`

Whether the license of the sync type is available. Absent when the type needs no license or the license cannot be determined.

---

**`status`**: `WorkerSyncRunStatus!`

What the sync is doing now.