younifyd
Menu

updateStore

Update an existing store — 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 updateStore action (under Update).
  3. Fill in the fields below, then reference the result from later steps as {{updatestore.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 UpdateStore($version: Long!, $actions: [StoreUpdateAction!]!, $id: String, $key: String) {
  updateStore(version: $version, actions: $actions, id: $id, key: $key) {
    id
    version
    key
    nameAllLocales {
      locale
      value
    }
    languages
    countries {
      code
    }
    productSelections {
      productSelectionRef {
        typeId
        id
      }
      productSelection {
        key
        nameAllLocales
        productCount
        custom
        mode
        id
        version
        createdAt
        lastModifiedAt
        createdBy
        lastModifiedBy
      }
      active
    }
    distributionChannelsRef {
      typeId
      id
    }
    distributionChannels {
      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
      }
      geoLocation {
        type
      }
      createdAt
      lastModifiedAt
      reviewRatingStatistics {
        averageRating
        highestRating
        lowestRating
        count
        ratingsDistribution
      }
      custom {
        typeRef
        type
      }
      createdBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
      lastModifiedBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
    }
    supplyChannelsRef {
      typeId
      id
    }
    supplyChannels {
      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
      }
      geoLocation {
        type
      }
      createdAt
      lastModifiedAt
      reviewRatingStatistics {
        averageRating
        highestRating
        lowestRating
        count
        ratingsDistribution
      }
      custom {
        typeRef
        type
      }
      createdBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
      lastModifiedBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
    }
    storefront {
      checkoutUrlTemplate
      orderUrlTemplate
      termsOfServiceUrl
      privacyPolicyUrl
      refundPolicyUrl
      shippingPolicyUrl
      cookiePolicyUrl
      imprintUrl
      faqUrl
      contactUrl
    }
    createdAt
    lastModifiedAt
    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.

versionstringrequired
actionsarray<object>required
addProductSelectionobject2 fields
addCountryobject1 fields
addDistributionChannelobject1 fields
addSupplyChannelobject1 fields
changeProductSelectionActiveobject2 fields
removeProductSelectionobject1 fields
removeCountryobject1 fields
removeDistributionChannelobject1 fields
removeSupplyChannelobject1 fields
setProductSelectionsobject1 fields
setCheckoutUrlTemplateobject1 fields
setContactUrlobject1 fields
setCookiePolicyUrlobject1 fields
setCountriesobject1 fields
setCustomFieldobject2 fields
setCustomTypeobject4 fields
setDistributionChannelsobject1 fields
setFaqUrlobject1 fields
setImprintUrlobject1 fields
setLanguagesobject1 fields
setNameobject1 fields
setOrderUrlTemplateobject1 fields
setPrivacyPolicyUrlobject1 fields
setRefundPolicyUrlobject1 fields
setShippingPolicyUrlobject1 fields
setSupplyChannelsobject1 fields
setTermsOfServiceUrlobject1 fields
idstring

Queries with specified ID

keystring

Queries with specified key

json
{
  "version": "string",
  "actions": [
    {
      "addProductSelection": {
        "productSelection": "string",
        "active": "string"
      },
      "addCountry": {
        "country": "string"
      },
      "addDistributionChannel": {
        "distributionChannel": "string"
      },
      "addSupplyChannel": {
        "supplyChannel": "string"
      },
      "changeProductSelectionActive": {
        "productSelection": "string",
        "active": "string"
      },
      "removeProductSelection": {
        "productSelection": "string"
      },
      "removeCountry": {
        "country": "string"
      },
      "removeDistributionChannel": {
        "distributionChannel": "string"
      },
      "removeSupplyChannel": {
        "supplyChannel": "string"
      },
      "setProductSelections": {
        "productSelections": "string"
      },
      "setCheckoutUrlTemplate": {
        "checkoutUrlTemplate": "string"
      },
      "setContactUrl": {
        "contactUrl": "string"
      }
    }
  ],
  "id": "string",
  "key": "string"
}

Response

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

idstring
versionstring
keystring
nameAllLocalesarray<object>
localeobject
valueobject
languagesarray<string>
countriesarray<object>
codeobject
productSelectionsarray<object>
productSelectionRefobject
productSelectionobject
activeobject
distributionChannelsRefarray<object>
typeIdobject
idobject
distributionChannelsarray<object>
idobject
versionobject
keyobject
rolesobject
nameAllLocalesobject
descriptionAllLocalesobject
addressobject
geoLocationobject
createdAtobject
lastModifiedAtobject
reviewRatingStatisticsobject
customobject
createdByobject
lastModifiedByobject
supplyChannelsRefarray<object>
typeIdobject
idobject
supplyChannelsarray<object>
idobject
versionobject
keyobject
rolesobject
nameAllLocalesobject
descriptionAllLocalesobject
addressobject
geoLocationobject
createdAtobject
lastModifiedAtobject
reviewRatingStatisticsobject
customobject
createdByobject
lastModifiedByobject
storefrontobject
checkoutUrlTemplatestring
orderUrlTemplatestring
termsOfServiceUrlstring
privacyPolicyUrlstring
refundPolicyUrlstring
shippingPolicyUrlstring
cookiePolicyUrlstring
imprintUrlstring
faqUrlstring
contactUrlstring
createdAtstring
lastModifiedAtstring
customobject
typeRefobject2 fields
typeobject10 fields
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?