Menu
createShippingMethod
Create a new shipping method.
Use it in a workflow
- Add a step and choose the Commercetools connector.
- Pick the createShippingMethod action (under Create).
- Fill in the fields below, then reference the result from later steps as
{{createshippingmethod.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 CreateShippingMethod($draft: ShippingMethodDraft!) {
createShippingMethod(draft: $draft) {
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.
{
"draft": {
"name": "string",
"taxCategory": {
"typeId": "string",
"id": "string",
"key": "string"
},
"isDefault": false,
"localizedName": [
{
"locale": "string",
"value": "string"
}
],
"description": "string",
"localizedDescription": [
{
"locale": "string",
"value": "string"
}
],
"zoneRates": [
{
"zone": "string",
"shippingRates": "string"
}
],
"active": false,
"predicate": "string",
"key": "string",
"custom": {
"typeId": "string",
"typeKey": "string",
"type": {
"typeId": "string",
"id": "string",
"key": "string"
},
"fields": [
"string"
]
},
"stores": [
{
"typeId": "string",
"id": "string",
"key": "string"
}
]
}
}
Response
Read the result with {{createshippingmethod.response.data.data.createShippingMethod}}. If the API returns errors, the step fails and they are at {{createshippingmethod.response.data.errors}}.
Need more? See the Commercetools guide for connection setup and behaviour shared by every action.
Was this page helpful?