younifyd
Menu

updateCartDiscount

Update an existing cart discount — pass its current version and an array of update actions.

Use it in a workflow

  1. Add a step and choose the Commercetools connector.
  2. Pick the updateCartDiscount action (under Update).
  3. Fill in the fields below, then reference the result from later steps as {{updatecartdiscount.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 UpdateCartDiscount($version: Long!, $actions: [CartDiscountUpdateAction!]!, $storeKey: KeyReferenceInput, $id: String, $key: String) {
  updateCartDiscount(
    version: $version
    actions: $actions
    storeKey: $storeKey
    id: $id
    key: $key
  ) {
    cartPredicate
    stackingMode
    isActive
    requiresDiscountCode
    key
    discountGroupRef {
      typeId
      id
    }
    nameAllLocales {
      locale
      value
    }
    descriptionAllLocales {
      locale
      value
    }
    referenceRefs {
      typeId
      id
    }
    custom {
      typeRef {
        typeId
        id
      }
      type {
        key
        nameAllLocales
        descriptionAllLocales
        resourceTypeIds
        id
        version
        createdAt
        lastModifiedAt
        createdBy
        lastModifiedBy
      }
    }
    validFrom
    validUntil
    storesRef {
      typeId
      key
    }
    stores {
      id
      version
      key
      nameAllLocales {
        locale
        value
      }
      languages
      countries {
        code
      }
      productSelections {
        productSelectionRef
        productSelection
        active
      }
      distributionChannelsRef {
        typeId
        id
      }
      distributionChannels {
        id
        version
        key
        roles
        nameAllLocales
        descriptionAllLocales
        address
        geoLocation
        createdAt
        lastModifiedAt
        reviewRatingStatistics
        custom
        createdBy
        lastModifiedBy
      }
      supplyChannelsRef {
        typeId
        id
      }
      supplyChannels {
        id
        version
        key
        roles
        nameAllLocales
        descriptionAllLocales
        address
        geoLocation
        createdAt
        lastModifiedAt
        reviewRatingStatistics
        custom
        createdBy
        lastModifiedBy
      }
      storefront {
        checkoutUrlTemplate
        orderUrlTemplate
        termsOfServiceUrl
        privacyPolicyUrl
        refundPolicyUrl
        shippingPolicyUrl
        cookiePolicyUrl
        imprintUrl
        faqUrl
        contactUrl
      }
      createdAt
      lastModifiedAt
      custom {
        typeRef
        type
      }
      createdBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
      lastModifiedBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
    }
    discountGroup {
      id
      version
      key
      sortOrder
      isActive
      nameAllLocales {
        locale
        value
      }
      descriptionAllLocales {
        locale
        value
      }
      createdAt
      lastModifiedAt
      createdBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
      lastModifiedBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
    }
    value {
      type
    }
    target {
      type
    }
    sortOrder
    recurringOrderScope {
      type
    }
    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.

versionstringrequired
actionsarray<object>required
setStoresobject1 fields
addStoreobject1 fields
removeStoreobject1 fields
setRecurringOrderScopeobject1 fields
changeCartPredicateobject1 fields
changeIsActiveobject1 fields
changeNameobject1 fields
changeRequiresDiscountCodeobject1 fields
changeSortOrderobject1 fields
changeStackingModeobject1 fields
changeTargetobject1 fields
changeValueobject1 fields
setCustomFieldobject2 fields
setCustomTypeobject4 fields
setDescriptionobject1 fields
setKeyobject1 fields
setValidFromobject1 fields
setValidFromAndUntilobject2 fields
setValidUntilobject1 fields
setDiscountGroupobject2 fields
storeKeystring

The mutation is only performed if the resource is part of the store. Can be used with store-specific OAuth permissions.

idstring

Queries with specified ID

keystring

Queries with specified key

json
{
  "version": "string",
  "actions": [
    {
      "setStores": {
        "stores": "string"
      },
      "addStore": {
        "store": "string"
      },
      "removeStore": {
        "store": "string"
      },
      "setRecurringOrderScope": {
        "recurringOrderScope": "string"
      },
      "changeCartPredicate": {
        "cartPredicate": "string"
      },
      "changeIsActive": {
        "isActive": "string"
      },
      "changeName": {
        "name": "string"
      },
      "changeRequiresDiscountCode": {
        "requiresDiscountCode": "string"
      },
      "changeSortOrder": {
        "sortOrder": "string"
      },
      "changeStackingMode": {
        "stackingMode": "string"
      },
      "changeTarget": {
        "target": "string"
      },
      "changeValue": {
        "value": "string"
      }
    }
  ],
  "storeKey": "string",
  "id": "string",
  "key": "string"
}

Response

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

cartPredicatestring
stackingModestring

One ofStackingStopAfterThisDiscount

isActiveboolean
requiresDiscountCodeboolean
keystring
discountGroupRefobject
typeIdstring
idstring
nameAllLocalesarray<object>
localeobject
valueobject
descriptionAllLocalesarray<object>
localeobject
valueobject
referenceRefsarray<object>
typeIdobject
idobject
customobject
typeRefobject2 fields
typeobject10 fields
validFromstring
validUntilstring
storesRefarray<object>
typeIdobject
keyobject
storesarray<object>
idobject
versionobject
keyobject
nameAllLocalesobject
languagesobject
countriesobject
productSelectionsobject
distributionChannelsRefobject
distributionChannelsobject
supplyChannelsRefobject
supplyChannelsobject
storefrontobject
createdAtobject
lastModifiedAtobject
customobject
createdByobject
lastModifiedByobject
discountGroupobject
idstring
versionstring
keystring
sortOrderstring
isActiveboolean
nameAllLocalesarray<object>
descriptionAllLocalesarray<object>
createdAtstring
lastModifiedAtstring
createdByobject8 fields
lastModifiedByobject8 fields
valueobject
typestring
targetobject
typestring
sortOrderstring
recurringOrderScopeobject
typestring

One ofAnyOrderNonRecurringOrdersOnlyRecurringOrdersOnlyApplicableRecurrencePolicies

idstring
versionstring
createdAtstring
lastModifiedAtstring
createdByobject
isPlatformClientboolean
clientIdstring
externalUserIdstring
anonymousIdstring
customerRefobject2 fields
userRefobject2 fields
associateRefobject2 fields
attributedToobject3 fields
lastModifiedByobject
isPlatformClientboolean
clientIdstring
externalUserIdstring
anonymousIdstring
customerRefobject2 fields
userRefobject2 fields
associateRefobject2 fields
attributedToobject3 fields

Need more? See the Commercetools guide for connection setup and behaviour shared by every action.

Was this page helpful?