associate

A single associate within a business unit — the person, their roles, and permissions.

Use it in a workflow

Add a step and choose the Commercetools connector.
Pick the associate action (under Associate).
Fill in the fields below, then reference the result from later steps as {{associate.response.data}}.

Query

This is the query the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

query Associate($businessUnitId: String, $businessUnitKey: String, $associateId: String!) {
  associate(
    businessUnitId: $businessUnitId
    businessUnitKey: $businessUnitKey
    associateId: $associateId
  ) {
    customerRef {
      typeId
      id
    }
    customer {
      id
      customerNumber
      email
      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
      }
      defaultShippingAddressId
      defaultBillingAddressId
      shippingAddressIds
      billingAddressIds
      isEmailVerified
      customerGroupRef {
        typeId
        id
      }
      externalId
      key
      authenticationMode
      firstName
      lastName
      middleName
      title
      locale
      salutation
      dateOfBirth
      companyName
      vatId
      password
      customerGroup {
        id
        version
        name
        key
        createdAt
        lastModifiedAt
        custom
        createdBy
        lastModifiedBy
      }
      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
      }
      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
      }
      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
      }
      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
      }
      storesRef {
        typeId
        key
      }
      stores {
        id
        version
        key
        nameAllLocales
        languages
        countries
        productSelections
        distributionChannelsRef
        distributionChannels
        supplyChannelsRef
        supplyChannels
        storefront
        createdAt
        lastModifiedAt
        custom
        createdBy
        lastModifiedBy
      }
      customerGroupAssignments {
        customerGroupRef
        customerGroup
      }
      custom {
        typeRef
        type
      }
      version
      createdAt
      lastModifiedAt
      createdBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
      lastModifiedBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
    }
    associateRoles {
      key
      buyerAssignable
      name
      permissions
      custom {
        typeRef
        type
      }
      id
      version
      createdAt
      lastModifiedAt
      createdBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
      lastModifiedBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
    }
    inheritedAssociateRoles {
      key
      buyerAssignable
      name
      permissions
      custom {
        typeRef
        type
      }
      id
      version
      createdAt
      lastModifiedAt
      createdBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
      lastModifiedBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
    }
    permissions
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

businessUnitIdstring

Queries with specified Business Unit ID

businessUnitKeystring

Queries with specified Business Unit key

associateIdstringrequired

Queries the specific associate within the Business Unit

json

{
  "associateId": "string",
  "businessUnitId": "string",
  "businessUnitKey": "string"
}

Response

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

customerRefobject

typeIdstring

idstring

customerobject

idstring

customerNumberstring

emailstring

addressesarray<object>

defaultShippingAddressIdstring

defaultBillingAddressIdstring

shippingAddressIdsarray<object>

billingAddressIdsarray<object>

isEmailVerifiedboolean

customerGroupRefobject2 fields

externalIdstring

keystring

authenticationModestring

One ofExternalAuthPassword

firstNamestring

lastNamestring

middleNamestring

titlestring

localestring

salutationstring

dateOfBirthstring

companyNamestring

vatIdstring

passwordstring

customerGroupobject9 fields

defaultShippingAddressobject26 fields

defaultBillingAddressobject26 fields

shippingAddressesarray<object>

billingAddressesarray<object>

storesRefarray<object>

storesarray<object>

customerGroupAssignmentsarray<object>

customobject2 fields

versionstring

createdAtstring

lastModifiedAtstring

createdByobject8 fields

lastModifiedByobject8 fields

associateRolesarray<object>

keyobject

buyerAssignableobject

nameobject

permissionsobject

customobject

idobject

versionobject

createdAtobject

lastModifiedAtobject

createdByobject

lastModifiedByobject

inheritedAssociateRolesarray<object>