Menu
createMyBusinessUnit
Create a new business unit for the signed-in customer.
Use it in a workflow
- Add a step and choose the Commercetools connector.
- Pick the createMyBusinessUnit action (under Create).
- Fill in the fields below, then reference the result from later steps as
{{createmybusinessunit.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 CreateMyBusinessUnit($draft: MyBusinessUnitDraft!) {
createMyBusinessUnit(draft: $draft) {
id
key
name
contactEmail
addresses {
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 {
typeRef
type
}
}
defaultShippingAddress {
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 {
typeRef
type
}
}
defaultBillingAddress {
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 {
typeRef
type
}
}
defaultShippingAddressId
defaultBillingAddressId
shippingAddresses {
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 {
typeRef
type
}
}
billingAddresses {
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 {
typeRef
type
}
}
shippingAddressIds
billingAddressIds
status
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
}
}
storeMode
unitType
associates {
associateRoleAssignments {
associateRoleRef
associateRole
inheritance
}
customerRef {
typeId
id
}
customer {
id
customerNumber
email
addresses
defaultShippingAddressId
defaultBillingAddressId
shippingAddressIds
billingAddressIds
isEmailVerified
customerGroupRef
externalId
key
authenticationMode
firstName
lastName
middleName
title
locale
salutation
dateOfBirth
companyName
vatId
password
customerGroup
defaultShippingAddress
defaultBillingAddress
shippingAddresses
billingAddresses
storesRef
stores
customerGroupAssignments
custom
version
createdAt
lastModifiedAt
createdBy
lastModifiedBy
}
}
associateMode
inheritedAssociates {
associateRoleAssignments {
associateRoleRef
associateRole
sourceRef
source
}
customerRef {
typeId
id
}
customer {
id
customerNumber
email
addresses
defaultShippingAddressId
defaultBillingAddressId
shippingAddressIds
billingAddressIds
isEmailVerified
customerGroupRef
externalId
key
authenticationMode
firstName
lastName
middleName
title
locale
salutation
dateOfBirth
companyName
vatId
password
customerGroup
defaultShippingAddress
defaultBillingAddress
shippingAddresses
billingAddresses
storesRef
stores
customerGroupAssignments
custom
version
createdAt
lastModifiedAt
createdBy
lastModifiedBy
}
}
custom {
typeRef {
typeId
id
}
type {
key
nameAllLocales
descriptionAllLocales
resourceTypeIds
id
version
createdAt
lastModifiedAt
createdBy
lastModifiedBy
}
}
parentUnitRef {
typeId
key
}
parentUnit
ancestors
inheritedStores {
store {
id
version
key
nameAllLocales
languages
countries
productSelections
distributionChannelsRef
distributionChannels
supplyChannelsRef
supplyChannels
storefront
createdAt
lastModifiedAt
custom
createdBy
lastModifiedBy
}
storeRef {
typeId
key
}
}
topLevelUnitRef {
typeId
key
}
topLevelUnit
approvalRuleMode
customerGroupAssignments {
customerGroupRef {
typeId
id
}
customerGroup {
id
version
name
key
createdAt
lastModifiedAt
custom
createdBy
lastModifiedBy
}
}
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": {
"key": "string",
"name": "string",
"unitType": "Company",
"contactEmail": "string",
"addresses": [
{
"country": "string",
"id": "string",
"title": "string",
"salutation": "string",
"firstName": "string",
"lastName": "string",
"streetName": "string",
"streetNumber": "string",
"additionalStreetInfo": "string",
"postalCode": "string",
"city": "string",
"region": "string"
}
],
"defaultBillingAddress": 0,
"defaultShippingAddress": 0,
"shippingAddresses": [
0
],
"billingAddresses": [
0
],
"custom": {
"typeId": "string",
"typeKey": "string",
"type": {
"typeId": "string",
"id": "string",
"key": "string"
},
"fields": [
"string"
]
},
"storeMode": "string",
"parentUnit": {
"typeId": "string",
"id": "string",
"key": "string"
}
}
}
Response
Read the result with {{createmybusinessunit.response.data.data.createMyBusinessUnit}}. If the API returns errors, the step fails and they are at {{createmybusinessunit.response.data.errors}}.
Need more? See the Commercetools guide for connection setup and behaviour shared by every action.
Was this page helpful?