Skip to main content
Server path: /commercetools-customers | Type: Application | PCID required: Yes

Tools

ToolDescription
commercetools_customers_create_associate_rolesCreating a Associate Role generates the AssociateRoleCreated Message.
commercetools_customers_create_business_unitsPOST /business-units
commercetools_customers_create_business_units_searchIf the initial indexing is in progress or the feature is inactive, A SearchNotReady error is returned. If inactive, you can reactivate it.
commercetools_customers_create_customer_groupsPOST /customer-groups
commercetools_customers_create_customersAllows converting an anonymous Cart to the active Cart of a Customer with cart merge. Creating a Customer produces the CustomerCreated Message. Simultaneously creating two Customers with the same email address can return a LockedField error.
commercetools_customers_create_customers_email_confirmUse this method to verify a global Customer’s email during their email verification process. Verifying the email of the Customer produces the CustomerEmailVerified Message. After the email is verified, all email tokens issued previously through the email verification flow are invalidated. This invalidation of tokens is eventually consistent.
commercetools_customers_create_customers_email_tokenUse this method to create an email token for a global Customer during their email verification process. Creating an email token for the Customer produces the CustomerEmailTokenCreated Message. The Message will include the token’s value, if the token’s validity is 60 minutes or less.
commercetools_customers_create_customers_passwordChanging the password produces the CustomerPasswordUpdated Message with reset=false.
commercetools_customers_create_customers_password_resetUse this method to reset a global Customer’s password during their password reset process. Resetting the password of the Customer produces the CustomerPasswordUpdated Message with reset=true. After the password is reset, all password tokens issued previously through the password reset flow are invalidated. In addition, any access and refresh tokens issued previously through the password flow and refresh token flow are invalidated. This invalidation of tokens is eventually consistent.
commercetools_customers_create_customers_password_tokenUse this method to create a password reset token for a global Customer during their password reset process. Creating a password reset token for the Customer produces the CustomerPasswordTokenCreated Message. The Message will include the token’s value, if the token’s validity is 60 minutes or less.
commercetools_customers_create_customers_searchIf the initial indexing is in progress or the feature is inactive, a SearchNotReady error is returned. If inactive, you can reactivate it.
commercetools_customers_delete_associate_roles_by_idDELETE /associate-roles/{ID}
commercetools_customers_delete_associate_roles_by_keyDeleting an AssociateRole generates the AssociateRoleDeleted Message. An AssociateRole can only be deleted if it is not assigned to any Associates.
commercetools_customers_delete_business_units_by_idDELETE /business-units/{ID}
commercetools_customers_delete_business_units_by_keyDELETE /business-units/key={key}
commercetools_customers_delete_by_idDeleting a Customer produces the CustomerDeleted Message.
commercetools_customers_delete_by_keyDeleting a Customer produces the CustomerDeleted Message.
commercetools_customers_delete_customer_groups_by_idDELETE /customer-groups/{ID}
commercetools_customers_delete_customer_groups_by_keyDELETE /customer-groups/key={key}
commercetools_customers_get_associate_roles_by_idGET /associate-roles/{ID}
commercetools_customers_get_associate_roles_by_keyGET /associate-roles/key={key}
commercetools_customers_get_business_units_associates_by_business_unit_id_and_associate_idRetrieves roles and permissions of an Associate in a Business Unit.
commercetools_customers_get_business_units_associates_by_key_and_associate_idRetrieves roles and permissions of an Associate in a Business Unit.
commercetools_customers_get_business_units_by_idGET /business-units/{ID}
commercetools_customers_get_business_units_by_keyGET /business-units/key={key}
commercetools_customers_get_by_idGET /customers/{ID}
commercetools_customers_get_by_keyGET /customers/key={key}
commercetools_customers_get_customer_groups_by_idGET /customer-groups/{ID}
commercetools_customers_get_customer_groups_by_keyGET /customer-groups/key={key}
commercetools_customers_list_associate_rolesGET /associate-roles
commercetools_customers_list_business_unitsGET /business-units
commercetools_customers_list_business_units_search_indexing_statusReturns the indexing status of the Business Unit Search for a Project.
commercetools_customers_list_customer_groupsGET /customer-groups
commercetools_customers_list_customersGET /customers
commercetools_customers_list_customers_email_token_email_tokenUse this method to retrieve a global Customer’s details by using the email token during their email verification process.
commercetools_customers_list_customers_password_token_password_tokenUse this method to retrieve the details of a global Customer by using the password token during their password reset process.
commercetools_customers_list_customers_search_indexing_statusReturns the indexing status of the Customer Search for a Project.
commercetools_customers_update_associate_roles_by_idPOST /associate-roles/{ID}
commercetools_customers_update_associate_roles_by_keyPOST /associate-roles/key={key}
commercetools_customers_update_business_units_by_idPOST /business-units/{ID}
commercetools_customers_update_business_units_by_keyPOST /business-units/key={key}
commercetools_customers_update_customer_groups_by_idPOST /customer-groups/{ID}
commercetools_customers_update_customer_groups_by_keyPOST /customer-groups/key={key}
commercetools_customers_update_customers_by_idSimultaneously updating two Customers with the same email address can return a LockedField error.
commercetools_customers_update_customers_by_keySimultaneously updating two Customers with the same email address can return a LockedField error.

commercetools_customers_create_associate_roles

Creating a Associate Role generates the AssociateRoleCreated Message. Parameters:
ParameterTypeRequiredDefaultDescription
expandstring[]NoRelated resources to expand inline
buyerAssignablebooleanNoBuyer Assignable
customobjectNoThe custom value
keystringYesThe key value
namestringNoThe name value
permissionsstring[]NoThe permissions value

commercetools_customers_create_business_units

POST /business-units Parameters:
ParameterTypeRequiredDefaultDescription
expandstring[]NoRelated resources to expand inline
addressesobject[]NoThe addresses value
approvalRuleModestringNoApproval Rule Mode
associateModestringNoAssociate Mode
associatesobject[]NoThe associates value
billingAddressesinteger[]NoBilling Addresses
contactEmailstringNoContact Email
customobjectNoThe custom value
customerGroupAssignmentsobject[]NoCustomer Group Assignments
defaultBillingAddressintegerNoDefault Billing Address
defaultShippingAddressintegerNoDefault Shipping Address
keystringYesThe key value
namestringYesThe name value
shippingAddressesinteger[]NoShipping Addresses
statusstringNoThe status value
storeModestringNoStore Mode
storesany[]NoThe stores value
unitTypestringYesUnit Type

If the initial indexing is in progress or the feature is inactive, A SearchNotReady error is returned. If inactive, you can reactivate it. Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoMaximum number of results to return
offsetintegerNoThe offset value
queryobjectNoSearch query string
sortobject[]NoSort order for results

commercetools_customers_create_customer_groups

POST /customer-groups Parameters:
ParameterTypeRequiredDefaultDescription
expandstring[]NoRelated resources to expand inline
customobjectNoThe custom value
groupNamestringYesGroup Name
keystringNoThe key value

commercetools_customers_create_customers

Allows converting an anonymous Cart to the active Cart of a Customer with cart merge. Creating a Customer produces the CustomerCreated Message. Simultaneously creating two Customers with the same email address can return a LockedField error. Parameters:
ParameterTypeRequiredDefaultDescription
expandstring[]NoRelated resources to expand inline
addressesobject[]NoThe addresses value
anonymousCartobjectNoAnonymous Cart
anonymousCartIdstringNoAnonymous Cart Id
anonymousIdstringNoAnonymous Id
authenticationModestringNoAuthentication Mode
billingAddressesinteger[]NoBilling Addresses
companyNamestringNoCompany Name
customobjectNoThe custom value
customerGroupobjectNoCustomer Group
customerGroupAssignmentsobject[]NoCustomer Group Assignments
customerNumberstringNoCustomer Number
dateOfBirthstringNoDate Of Birth
defaultBillingAddressintegerNoDefault Billing Address
defaultShippingAddressintegerNoDefault Shipping Address
emailstringYesThe email value
externalIdstringNoExternal Id
firstNamestringNoFirst Name
isEmailVerifiedbooleanNoIs Email Verified
keystringNoThe key value
lastNamestringNoLast Name
localestringNoLocale or language code
middleNamestringNoMiddle Name
passwordstringNoThe password value
salutationstringNoThe salutation value
shippingAddressesinteger[]NoShipping Addresses
storesany[]NoThe stores value
titlestringNoThe title value
vatIdstringNoVat Id

commercetools_customers_create_customers_email_confirm

Use this method to verify a global Customer’s email during their email verification process. Verifying the email of the Customer produces the CustomerEmailVerified Message. After the email is verified, all email tokens issued previously through the email verification flow are invalidated. This invalidation of tokens is eventually consistent. Parameters:
ParameterTypeRequiredDefaultDescription
tokenValuestringYesToken Value
versionintegerNoThe version value

commercetools_customers_create_customers_email_token

Use this method to create an email token for a global Customer during their email verification process. Creating an email token for the Customer produces the CustomerEmailTokenCreated Message. The Message will include the token’s value, if the token’s validity is 60 minutes or less. Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value
invalidateOlderTokensbooleanNoInvalidate Older Tokens
ttlMinutesintegerYesTtl Minutes
versionintegerNoThe version value

commercetools_customers_create_customers_password

Changing the password produces the CustomerPasswordUpdated Message with reset=false. Parameters:
ParameterTypeRequiredDefaultDescription
currentPasswordstringYesCurrent Password
idstringYesThe id value
newPasswordstringYesNew Password
versionintegerYesThe version value

commercetools_customers_create_customers_password_reset

Use this method to reset a global Customer’s password during their password reset process. Resetting the password of the Customer produces the CustomerPasswordUpdated Message with reset=true. After the password is reset, all password tokens issued previously through the password reset flow are invalidated. In addition, any access and refresh tokens issued previously through the password flow and refresh token flow are invalidated. This invalidation of tokens is eventually consistent. Parameters:
ParameterTypeRequiredDefaultDescription
newPasswordstringYesNew Password
tokenValuestringYesToken Value
versionintegerNoThe version value

commercetools_customers_create_customers_password_token

Use this method to create a password reset token for a global Customer during their password reset process. Creating a password reset token for the Customer produces the CustomerPasswordTokenCreated Message. The Message will include the token’s value, if the token’s validity is 60 minutes or less. Parameters:
ParameterTypeRequiredDefaultDescription
emailstringYesThe email value
invalidateOlderTokensbooleanNoInvalidate Older Tokens
ttlMinutesintegerNoTtl Minutes

If the initial indexing is in progress or the feature is inactive, a SearchNotReady error is returned. If inactive, you can reactivate it. Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoMaximum number of results to return
offsetintegerNoThe offset value
queryobjectNoSearch query string
sortobject[]NoSort order for results

commercetools_customers_delete_associate_roles_by_id

DELETE /associate-roles/{ID} Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
versionintegerYesThe version value
expandstring[]NoRelated resources to expand inline

commercetools_customers_delete_associate_roles_by_key

Deleting an AssociateRole generates the AssociateRoleDeleted Message. An AssociateRole can only be deleted if it is not assigned to any Associates. Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
versionintegerYesThe version value
expandstring[]NoRelated resources to expand inline

commercetools_customers_delete_business_units_by_id

DELETE /business-units/{ID} Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
versionintegerYesThe version value
expandstring[]NoRelated resources to expand inline

commercetools_customers_delete_business_units_by_key

DELETE /business-units/key={key} Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
versionintegerYesThe version value
expandstring[]NoRelated resources to expand inline

commercetools_customers_delete_by_id

Deleting a Customer produces the CustomerDeleted Message. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
dataErasurebooleanNoData Erasure
versionintegerYesThe version value
expandstring[]NoRelated resources to expand inline

commercetools_customers_delete_by_key

Deleting a Customer produces the CustomerDeleted Message. Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
dataErasurebooleanNoData Erasure
versionintegerYesThe version value
expandstring[]NoRelated resources to expand inline

commercetools_customers_delete_customer_groups_by_id

DELETE /customer-groups/{ID} Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
versionintegerYesThe version value
expandstring[]NoRelated resources to expand inline

commercetools_customers_delete_customer_groups_by_key

DELETE /customer-groups/key={key} Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
versionintegerYesThe version value
expandstring[]NoRelated resources to expand inline

commercetools_customers_get_associate_roles_by_id

GET /associate-roles/{ID} Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
expandstring[]NoRelated resources to expand inline

commercetools_customers_get_associate_roles_by_key

GET /associate-roles/key={key} Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
expandstring[]NoRelated resources to expand inline

commercetools_customers_get_business_units_associates_by_business_unit_id_and_associate_id

Retrieves roles and permissions of an Associate in a Business Unit. Parameters:
ParameterTypeRequiredDefaultDescription
businessUnitIdstringYesBusiness Unit Id
associateIdstringYesAssociate Id

commercetools_customers_get_business_units_associates_by_key_and_associate_id

Retrieves roles and permissions of an Associate in a Business Unit. Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
associateIdstringYesAssociate Id

commercetools_customers_get_business_units_by_id

GET /business-units/{ID} Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
expandstring[]NoRelated resources to expand inline

commercetools_customers_get_business_units_by_key

GET /business-units/key={key} Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
expandstring[]NoRelated resources to expand inline

commercetools_customers_get_by_id

GET /customers/{ID} Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
expandstring[]NoRelated resources to expand inline

commercetools_customers_get_by_key

GET /customers/key={key} Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
expandstring[]NoRelated resources to expand inline

commercetools_customers_get_customer_groups_by_id

GET /customer-groups/{ID} Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
expandstring[]NoRelated resources to expand inline

commercetools_customers_get_customer_groups_by_key

GET /customer-groups/key={key} Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
expandstring[]NoRelated resources to expand inline

commercetools_customers_list_associate_roles

GET /associate-roles Parameters:
ParameterTypeRequiredDefaultDescription
expandstring[]NoRelated resources to expand inline
sortstring[]NoSort order for results
limitintegerNoMaximum number of results to return
offsetintegerNoThe offset value
withTotalbooleanNoWith Total
wherestring[]NoThe where value

commercetools_customers_list_business_units

GET /business-units Parameters:
ParameterTypeRequiredDefaultDescription
expandstring[]NoRelated resources to expand inline
sortstring[]NoSort order for results
limitintegerNoMaximum number of results to return
offsetintegerNoThe offset value
withTotalbooleanNoWith Total
wherestring[]NoThe where value

commercetools_customers_list_business_units_search_indexing_status

Returns the indexing status of the Business Unit Search for a Project.

commercetools_customers_list_customer_groups

GET /customer-groups Parameters:
ParameterTypeRequiredDefaultDescription
wherestring[]NoThe where value
expandstring[]NoRelated resources to expand inline
sortstring[]NoSort order for results
limitintegerNoMaximum number of results to return
offsetintegerNoThe offset value
withTotalbooleanNoWith Total

commercetools_customers_list_customers

GET /customers Parameters:
ParameterTypeRequiredDefaultDescription
expandstring[]NoRelated resources to expand inline
sortstring[]NoSort order for results
limitintegerNoMaximum number of results to return
offsetintegerNoThe offset value
withTotalbooleanNoWith Total
wherestring[]NoThe where value

commercetools_customers_list_customers_email_token_email_token

Use this method to retrieve a global Customer’s details by using the email token during their email verification process. Parameters:
ParameterTypeRequiredDefaultDescription
emailTokenstringYesEmail Token
expandstring[]NoRelated resources to expand inline

commercetools_customers_list_customers_password_token_password_token

Use this method to retrieve the details of a global Customer by using the password token during their password reset process. Parameters:
ParameterTypeRequiredDefaultDescription
passwordTokenstringYesPassword Token
expandstring[]NoRelated resources to expand inline

commercetools_customers_list_customers_search_indexing_status

Returns the indexing status of the Customer Search for a Project.

commercetools_customers_update_associate_roles_by_id

POST /associate-roles/{ID} Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
expandstring[]NoRelated resources to expand inline
actionsobject[]YesThe actions value
versionintegerYesThe version value

commercetools_customers_update_associate_roles_by_key

POST /associate-roles/key={key} Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
expandstring[]NoRelated resources to expand inline
actionsobject[]YesThe actions value
versionintegerYesThe version value

commercetools_customers_update_business_units_by_id

POST /business-units/{ID} Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
expandstring[]NoRelated resources to expand inline
actionsobject[]YesThe actions value
versionintegerYesThe version value

commercetools_customers_update_business_units_by_key

POST /business-units/key={key} Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
expandstring[]NoRelated resources to expand inline
actionsobject[]YesThe actions value
versionintegerYesThe version value

commercetools_customers_update_customer_groups_by_id

POST /customer-groups/{ID} Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
expandstring[]NoRelated resources to expand inline
actionsobject[]YesThe actions value
versionintegerYesThe version value

commercetools_customers_update_customer_groups_by_key

POST /customer-groups/key={key} Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
expandstring[]NoRelated resources to expand inline
actionsobject[]YesThe actions value
versionintegerYesThe version value

commercetools_customers_update_customers_by_id

Simultaneously updating two Customers with the same email address can return a LockedField error. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
expandstring[]NoRelated resources to expand inline
actionsobject[]YesThe actions value
versionintegerYesThe version value

commercetools_customers_update_customers_by_key

Simultaneously updating two Customers with the same email address can return a LockedField error. Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
expandstring[]NoRelated resources to expand inline
actionsobject[]YesThe actions value
versionintegerYesThe version value