Menu
deleteChannel
Delete a channel (requires its current version).
Use it in a workflow
- Add a step and choose the Commercetools connector.
- Pick the deleteChannel action (under Delete).
- Fill in the fields below, then reference the result from later steps as
{{deletechannel.response.data}}.
Query
This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.
mutation DeleteChannel($id: String, $key: String, $version: Long!) {
deleteChannel(id: $id, key: $key, version: $version) {
id
version
key
roles
nameAllLocales {
locale
value
}
descriptionAllLocales {
locale
value
}
address {
id
streetName
streetNumber
additionalStreetInfo
postalCode
city
region
state
country
company
department
building
apartment
pOBox
additionalAddressInfo
externalId
key
phone
mobile
email
fax
title
salutation
firstName
lastName
custom {
typeRef
type
}
}
geoLocation {
type
}
createdAt
lastModifiedAt
reviewRatingStatistics {
averageRating
highestRating
lowestRating
count
ratingsDistribution
}
custom {
typeRef {
typeId
id
}
type {
key
nameAllLocales
descriptionAllLocales
resourceTypeIds
id
version
createdAt
lastModifiedAt
createdBy
lastModifiedBy
}
}
createdBy {
isPlatformClient
clientId
externalUserId
anonymousId
customerRef {
typeId
id
}
userRef {
typeId
id
}
associateRef {
typeId
id
}
attributedTo {
clientId
source
userRef
}
}
lastModifiedBy {
isPlatformClient
clientId
externalUserId
anonymousId
customerRef {
typeId
id
}
userRef {
typeId
id
}
associateRef {
typeId
id
}
attributedTo {
clientId
source
userRef
}
}
}
}
Variables
Pass these as a JSON object in the step's Variables field.
{
"version": "string",
"id": "string",
"key": "string"
}
Response
Read the result with {{deletechannel.response.data.data.deleteChannel}}. If the API returns errors, the step fails and they are at {{deletechannel.response.data.errors}}.
Need more? See the Commercetools guide for connection setup and behaviour shared by every action.
Was this page helpful?