Skip to main content
PATCH
/
v1
/
items
/
salesChannels
Update Item Sales Channels
curl --request PATCH \
  --url https://api.jtl-cloud.com/erp/v1/items/salesChannels \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-appid: <x-appid>' \
  --header 'x-appversion: <x-appversion>' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "ApplyToAllChildItems": true,
  "Items": [
    123
  ],
  "ActivateSalesChannels": [
    123
  ],
  "DeactivateSalesChannels": [
    123
  ]
}
'
{
  "NotActivatedForJtlPosItems": [
    {
      "Item": 123,
      "SalesChannel": "<string>"
    }
  ],
  "NotActivatedForScxDueToPartialItems": [
    {
      "Item": 123,
      "SalesChannel": "<string>"
    }
  ],
  "NotActivatedForScxForMissingChildItems": [
    {
      "Item": 123,
      "SalesChannel": "<string>"
    }
  ],
  "NotActivatedBecauseInactiveItems": [
    {
      "Item": 123,
      "SalesChannel": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

x-api-key
string
header
required

Optional: If no token is present, the API Gateway injects it.

Headers

x-appid
string
required

This is the name of your application, e.g. "MyApp/1.0.0". It is used to identify your application.

x-appversion
string
required

This is where the version number of your application is entered, e.g. "1.0.0".

x-runas
string

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

X-SessionId
string<uuid>

The id of a session in which the call will be executed.

x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Body

application/json

The sales channels to update

Model Class: UpdateItemSalesChannels

ApplyToAllChildItems
boolean

Specifies if sales channel activation should be applied to all child items.

Items
integer<int32>[]

The IDs of the items for which sales channels should be updated.

ActivateSalesChannels
integer<int32>[]

The IDs of the sales channels that should be activated. Only specific sales channels are allowed for this operation and are specified in the sales channel endpoint (GET).

DeactivateSalesChannels
integer<int32>[]

The ID of the sales channel for this description. Only specific sales channels are allowed for this operation and are specified in the sales channel endpoint (GET).

Response

The Update Saleschannels.

Model Class: UpdateItemSalesChannelsResponse

NotActivatedForJtlPosItems
object[]
required

The IDs of the items for which JTL-POS sales channels could not be activated.

NotActivatedForScxDueToPartialItems
object[]
required

The IDs of the items for which sales channels cuold not be activated because they are partial items.

NotActivatedForScxForMissingChildItems
object[]
required

The IDs of the items for which sales channels cuold not be activated because they are parent items without children.

NotActivatedBecauseInactiveItems
object[]
required

The IDs of the items for which sales channels cuold not be activated because they are inactive items.