JTjtl-software
worker

Configure Sync

Restart the Worker

post/v2/workers/{syncId}

Request

  • Base URL
    https://scx-sbx.api.jtl-software.com
  • Auth
    • OAuth 2
      Authorization codehttps://auth.jtl-cloud.com/oauth2/auth
      Token URLhttps://auth.jtl-cloud.com/oauth2/token
      Scopessystem.worker.write
    • or OAuth 2
      Client credentials
      Token URLhttps://auth.jtl-cloud.com/oauth2/token
      Scopessystem.worker.write
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

syncIdstring uuid required

Represents a configuration key that serves as a unique identifier for configuration entities.

The id of the job to Configure

Headers

x-tenant-idstring uuid required

The tenant ID for the target ERP instance.

x-runasstring

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

x-companyidstring

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

Request body

intervalstring duration

The Sync Interval

Response

The changed Worker Configuration

identifierstring uuid

Represents a configuration key that serves as a unique identifier for configuration entities.

syncNamestring

the Name of the Sync

salesChannelNamestring

The Name of the Sales Channel

salesChannelIdstring

The SalesChannel for the Sync

intervalstring duration

The Sync Interval

reportProgressboolean

The Sync can Report Progress in Percent

Changes

No recorded changes to this operation across all 1 revision of this API.