Menu
updateShippingMethod
Update an existing shipping method — pass its current version and an array of update actions.
Use it in a workflow
- Add a step and choose the Commercetools connector.
- Pick the updateShippingMethod action (under Update).
- Fill in the fields below, then reference the result from later steps as
{{updateshippingmethod.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 UpdateShippingMethod($version: Long!, $actions: [ShippingMethodUpdateAction!]!, $id: String, $key: String) {
updateShippingMethod(version: $version, actions: $actions, id: $id, key: $key) {
name
zoneRates {
shippingRates {
price
freeAbove
isMatching
tiers
}
zoneRef {
typeId
id
}
zone {
name
key
description
locations
id
version
createdAt
lastModifiedAt
createdBy
lastModifiedBy
}
}
active
isDefault
predicate
key
carrier
taxCategoryRef {
typeId
id
}
localizedDescriptionAllLocales {
locale
value
}
localizedNameAllLocales {
locale
value
}
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
}
}
taxCategory {
name
description
rates {
name
amount
includedInPrice
country
state
id
key
subRates
}
key
id
version
createdAt
lastModifiedAt
createdBy {
isPlatformClient
clientId
externalUserId
anonymousId
customerRef
userRef
associateRef
attributedTo
}
lastModifiedBy {
isPlatformClient
clientId
externalUserId
anonymousId
customerRef
userRef
associateRef
attributedTo
}
}
custom {
typeRef {
typeId
id
}
type {
key
nameAllLocales
descriptionAllLocales
resourceTypeIds
id
version
createdAt
lastModifiedAt
createdBy
lastModifiedBy
}
}
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.
{
"version": "string",
"actions": [
{
"addStore": {
"store": "string"
},
"addShippingRate": {
"zone": "string",
"shippingRate": "string"
},
"addZone": {
"zone": "string"
},
"changeActive": {
"active": "string"
},
"changeIsDefault": {
"isDefault": "string"
},
"changeName": {
"name": "string"
},
"changeTaxCategory": {
"taxCategory": "string"
},
"removeStore": {
"store": "string"
},
"removeShippingRate": {
"zone": "string",
"shippingRate": "string"
},
"removeZone": {
"zone": "string"
},
"setCarrier": {
"carrier": "string"
},
"setCustomField": {
"name": "string",
"value": "string"
}
}
],
"id": "string",
"key": "string"
}
Response
Read the result with {{updateshippingmethod.response.data.data.updateShippingMethod}}. If the API returns errors, the step fails and they are at {{updateshippingmethod.response.data.errors}}.
Need more? See the Commercetools guide for connection setup and behaviour shared by every action.
Was this page helpful?