> ## 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.

# WorkerSyncOption

> A setting of a sync, with its description and its value. Only the options that belong to the type of the sync are listed.



**Kind**: `object`

## Fields

**`key`**: `String!`

The stable key of the option, for example ebay.createOrderImmediately.

---

**`label`**: `String!`

The name in the language of the caller.

---

**`description`**: `String`

What the option does, in the language of the caller.

---

**`valueType`**: `OptionValueType!`

The data type of the value.

---

**`isRequired`**: `Boolean!`

Whether the option needs a value.

---

**`isSharedAcrossSyncs`**: `Boolean!`

Whether a change applies to all syncs of the same type. Today every option is stored once per tenant and type, so it does.

---

**`value`**: `OptionValue`

The value.

---

**`defaultValue`**: `OptionValue`

The value the option has when nobody set one.