deleteCustomObject

Delete a custom object (requires its current version).

Use it in a workflow

Add a step and choose the Commercetools connector.
Pick the deleteCustomObject action (under Delete).
Fill in the fields below, then reference the result from later steps as {{deletecustomobject.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.

graphql

mutation DeleteCustomObject($version: Long, $id: String, $key: String, $container: String, $personalDataErasure: Boolean) {
  deleteCustomObject(
    version: $version
    id: $id
    key: $key
    container: $container
    personalDataErasure: $personalDataErasure
  ) {
    container
    key
    value
    id
    version
    createdAt
    lastModifiedAt
    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.

versionstring

idstring

Queries with specified ID

keystring

Queries with specified key

containerstring

personalDataErasureboolean

json

{
  "version": "string",
  "id": "string",
  "key": "string",
  "container": "string",
  "personalDataErasure": false
}

Response

Read the result with {{deletecustomobject.response.data.data.deleteCustomObject}}. If the API returns errors, the step fails and they are at {{deletecustomobject.response.data.errors}}.

containerstring

keystring

valuestring

idstring

versionstring

createdAtstring

lastModifiedAtstring

createdByobject

isPlatformClientboolean

clientIdstring

externalUserIdstring

anonymousIdstring

customerRefobject2 fields

userRefobject2 fields

associateRefobject2 fields

attributedToobject3 fields

lastModifiedByobject