ExternalAuth
authentication mode cannot be set with this API.Representations
MyCustomerDraft
email ​String​ | Email address of the Customer that is unique for an entire Project or Store the Customer is assigned to.
It is the mandatory unique identifier of a Customer. |
password ​String​ | Password of the Customer. |
firstName ​String​ | Given name (first name) of the Customer. |
lastName ​String​ | Family name (last name) of the Customer. |
middleName ​String​ | Middle name of the Customer. |
title ​String​ | Title of the Customer, for example, 'Dr.'. |
salutation ​String​ | Salutation of the Customer, for example, 'Mr.' or 'Mrs.'. |
dateOfBirth ​Date​ | Date of birth of the Customer. |
companyName ​String​ | Company name of the Customer. |
vatId ​String​ | Individual VAT ID of the Customer. |
addresses ​Array of BaseAddress​ | Addresses of the Customer. |
defaultShippingAddress ​Int​ | Index of the address in the addresses array to use as the default shipping address.
The defaultShippingAddressId of the Customer will be set to the id of that address. |
defaultBillingAddress ​Int​ | Index of the address in the addresses array to use as the default billing address.
The defaultBillingAddressId of the Customer will be set to the id of that address. |
locale ​Locale​ | Preferred language of the Customer. Must be one of the languages supported by the Project. |
stores ​Array of StoreResourceIdentifier​ | Sets the Stores for the Customer. |
custom ​ | Custom Fields for the Customer. |
MyCustomerSignin
email ​String​ | Email address of the Customer treated as case-insensitive. |
password ​String​ | Password of the Customer. |
activeCartSignInMode ​ | |
updateProductData ​Boolean​ |
|
{
"email": "johndoe@example.com",
"password": "secret123"
}
MyCustomerChangePassword
version ​Int​ | Expected version of the Customer on which the changes should be applied. |
currentPassword ​String​ | Current password of the Customer. If the current password does not match, an InvalidCurrentPassword error is returned. |
newPassword ​String​ | New password to be set. |
{
"version": 1,
"currentPassword": "secret123",
"newPassword": "newSecret456"
}
MyCustomerResetPassword
tokenValue ​String​ | Value of the token to reset the Customer password. |
newPassword ​String​ | New password to be set. |
{
"tokenValue": "VRndRV5oCr-pKH2360DnlhqEOVVUZXSAIUXgT5HL",
"newPassword": "newsecret123"
}
MyCustomerEmailVerify
tokenValue ​String​ | Value of the token to verify Customer email. |
{
"tokenValue": "hI_6fkuFIyd_wadz1JmpRGh1vMvgFrlsSJia3G6d"
}
Get My Customer
200 OK
status if successful.- If no Customer exists for the given Query Predicate.
- If a Customer exists for the given Query Predicate, but does not have an
id
value that matches the customer:{id} scope.
manage_my_profile:{projectKey}
customer_id:{id}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
where | The parameter can be passed multiple times. |
sort | The parameter can be passed multiple times. |
expand | The parameter can be passed multiple times. |
limit Int ​ | Number of results requested. Default: 20 ​Minimum: 0 ​Maximum: 500 ​ |
offset Int ​ | Number of elements skipped. Default: 0 ​Maximum: 10000 ​ |
withTotal Boolean ​ | Controls the calculation of the total number of query results. Set to false to improve query performance when the total is not needed.Default: true ​ |
var.<varName> String ​ | Predicate parameter values. The parameter can be passed multiple times. |
application/json
curl --get https://api.{region}.commercetools.com/{projectKey}/me -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"
{
"id": "3cdcdcc8-80c5-41bb-abb5-ac8772c9cc24",
"version": 1,
"createdAt": "2022-09-19T14:34:35.843Z",
"lastModifiedAt": "2022-09-19T14:34:35.843Z",
"lastModifiedBy": {
"clientId": "P1Xf1NG2YsFqH2LC31oveDWT",
"isPlatformClient": false
},
"createdBy": {
"clientId": "P1Xf1NG2YsFqH2LC31oveDWT",
"isPlatformClient": false
},
"email": "johndoe@example.com",
"firstName": "John",
"lastName": "Doe",
"password": "****aGg=",
"addresses": [],
"shippingAddressIds": [],
"billingAddressIds": [],
"isEmailVerified": false,
"stores": [],
"authenticationMode": "Password"
}
Get My Customer in Store BETA
200 OK
status if successful.- If no Customer exists in the Store for the given Query Predicate.
- If a Customer exists in the Store for the given Query Predicate, but does not have an
id
value that matches the customer:{id} scope. - If a Customer exists for the given Query Predicate but is associated with a different Store than what is specified in the
manage_my_profile:{projectKey}:{storeKey}
scope.
manage_my_profile:{projectKey}
manage_my_profile:{projectKey}:{storeKey}
customer_id:{id}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
storeKey String ​ | key of the Store. |
where | The parameter can be passed multiple times. |
sort | The parameter can be passed multiple times. |
expand | The parameter can be passed multiple times. |
limit Int ​ | Number of results requested. Default: 20 ​Minimum: 0 ​Maximum: 500 ​ |
offset Int ​ | Number of elements skipped. Default: 0 ​Maximum: 10000 ​ |
withTotal Boolean ​ | Controls the calculation of the total number of query results. Set to false to improve query performance when the total is not needed.Default: true ​ |
var.<varName> String ​ | Predicate parameter values. The parameter can be passed multiple times. |
application/json
curl --get https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/me -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"
{
"id": "3cdcdcc8-80c5-41bb-abb5-ac8772c9cc24",
"version": 1,
"createdAt": "2022-09-19T14:34:35.843Z",
"lastModifiedAt": "2022-09-19T14:34:35.843Z",
"lastModifiedBy": {
"clientId": "P1Xf1NG2YsFqH2LC31oveDWT",
"isPlatformClient": false
},
"createdBy": {
"clientId": "P1Xf1NG2YsFqH2LC31oveDWT",
"isPlatformClient": false
},
"email": "johndoe@example.com",
"firstName": "John",
"lastName": "Doe",
"password": "****aGg=",
"addresses": [],
"shippingAddressIds": [],
"billingAddressIds": [],
"isEmailVerified": false,
"stores": [],
"authenticationMode": "Password"
}
Create (sign up) My Customer
anonymousId
are assigned to the newly created Customer.anonymousId
are assigned to the newly created Customer.manage_my_profile:{projectKey}
anonymous_id:{id}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
application/json
application/json
curl https://api.{region}.commercetools.com/{projectKey}/me/signup -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA
{
"email" : "johndoe@example.com",
"firstName" : "John",
"lastName" : "Doe",
"password" : "secret123"
}
DATA
{
"customer": {
"addresses": [],
"email": "johndoe@example.com",
"firstName": "John",
"id": "some_123_id",
"isEmailVerified": false,
"lastName": "Doe",
"password": "****aGg=",
"version": 1,
"createdAt": "2015-07-06T13:22:33.339Z",
"lastModifiedAt": "2015-07-06T13:22:33.339Z",
"authenticationMode": "Password",
"stores": []
}
}
Create (sign up) My Customer in Store BETA
anonymousId
are assigned to the newly created Customer.anonymousId
are assigned to the newly created Customer.stores
field is set to the Store specified in the path parameter.manage_my_profile:{projectKey}
manage_my_profile:{projectKey}:{storeKey}
anonymous_id:{id}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
storeKey String ​ | key of the Store. |
application/json
application/json
curl https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/me/signup -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA
{
"email" : "johndoe@example.com",
"firstName" : "John",
"lastName" : "Doe",
"password" : "secret123"
}
DATA
{
"customer": {
"addresses": [],
"email": "johndoe@example.com",
"firstName": "John",
"id": "some_123_id",
"isEmailVerified": false,
"lastName": "Doe",
"password": "****aGg=",
"version": 1,
"createdAt": "2015-07-06T13:22:33.339Z",
"lastModifiedAt": "2015-07-06T13:22:33.339Z",
"authenticationMode": "Password",
"stores": []
}
}
Authenticate (sign in) My Customer
anonymousId
are assigned to the newly created Customer.Retrieves the authenticated customer (that matches the given email/password pair).
anonymousId
are assigned to the newly logged-in Customer.- If the Customer does not have a Cart yet, the most recently modified anonymous cart becomes the Customer's Cart.
- If the Customer already has a Cart, the most recently modified anonymous cart is handled in accordance with AnonymousCartSignInMode.
manage_my_profile:{projectKey}
anonymous_id:{id}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
application/json
application/json
curl https://api.{region}.commercetools.com/{projectKey}/me/login -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA
{
"email" : "johndoe@example.com",
"password" : "secret123"
}
DATA
{
"customer": {
"addresses": [],
"email": "johndoe@example.com",
"firstName": "John",
"id": "some_123_id",
"isEmailVerified": false,
"lastName": "Doe",
"password": "****aGg=",
"version": 1,
"createdAt": "2015-07-06T13:22:33.339Z",
"lastModifiedAt": "2015-07-06T13:22:33.339Z",
"authenticationMode": "Password",
"stores": []
}
}
Authenticate (sign in) My Customer in Store BETA
anonymousId
are assigned to the newly created Customer.anonymousId
are assigned to the newly logged-in Customer.- If the Customer does not have a Cart, the most recently modified anonymous cart becomes the Customer's Cart.
- If the Customer already has a Cart, the most recently modified anonymous cart is handled according to AnonymousCartSignInMode.
manage_my_profile:{projectKey}
manage_my_profile:{projectKey}:{storeKey}
anonymous_id:{id}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
storeKey String ​ | key of the Store. |
application/json
application/json
curl https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/me/login -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA
{
"email" : "johndoe@example.com",
"password" : "secret123"
}
DATA
{
"customer": {
"addresses": [],
"email": "johndoe@example.com",
"firstName": "John",
"id": "some_123_id",
"isEmailVerified": false,
"lastName": "Doe",
"password": "****aGg=",
"version": 1,
"createdAt": "2015-07-06T13:22:33.339Z",
"lastModifiedAt": "2015-07-06T13:22:33.339Z",
"authenticationMode": "Password",
"stores": []
}
}
Update My Customer
200 OK
status if successful.manage_my_profile:{projectKey}
customer_id:{id}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
application/json
version ​Int​ | Expected version of the Customer on which the changes should be applied.
If the expected version does not match the actual version, a ConcurrentModification error will be returned. |
actions ​Array of MyCustomerUpdateAction​ | Update actions to be performed on the Customer. |
application/json
curl https://api.{region}.commercetools.com/{projectKey}/me -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA
{
"version" : 3,
"actions" : [ {
"action" : "addAddress",
"address" : {
"streetName" : "Any Street",
"streetNumber" : "1337",
"postalCode" : "11111",
"city" : "Any City",
"country" : "US"
}
} ]
}
DATA
{
"addresses": [
{
"city": "Any City",
"country": "US",
"id": "some_456_id",
"postalCode": "11111",
"streetName": "Any Street",
"streetNumber": "1337"
}
],
"email": "janedoe@example.com",
"firstName": "Jane",
"id": "some_123_id",
"isEmailVerified": false,
"lastName": "Doe",
"password": "****aGg=",
"version": 4,
"createdAt": "2015-05-06T12:10:12.421Z",
"lastModifiedAt": "2015-07-06T13:22:33.339Z",
"authenticationMode": "Password",
"stores": []
}
Update My Customer in Store BETA
200 OK
status if successful.- If no Customer exists with the
id
specified in the customer:{id} scope. - If the Customer exists but is associated with a different Store than what is specified in the
manage_my_profile:{projectKey}:{storeKey}
scope.
manage_my_profile:{projectKey}
manage_my_profile:{projectKey}:{storeKey}
customer_id:{id}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
storeKey String ​ | key of the Store. |
application/json
version ​Int​ | Expected version of the Customer on which the changes should be applied.
If the expected version does not match the actual version, a ConcurrentModification error will be returned. |
actions ​Array of MyCustomerUpdateAction​ | Update actions to be performed on the Customer. |
application/json
curl https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/me -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA
{
"version" : 3,
"actions" : [ {
"action" : "addAddress",
"address" : {
"streetName" : "Any Street",
"streetNumber" : "1337",
"postalCode" : "11111",
"city" : "Any City",
"country" : "US"
}
} ]
}
DATA
{
"addresses": [
{
"city": "Any City",
"country": "US",
"id": "some_456_id",
"postalCode": "11111",
"streetName": "Any Street",
"streetNumber": "1337"
}
],
"email": "janedoe@example.com",
"firstName": "Jane",
"id": "some_123_id",
"isEmailVerified": false,
"lastName": "Doe",
"password": "****aGg=",
"version": 4,
"createdAt": "2015-05-06T12:10:12.421Z",
"lastModifiedAt": "2015-07-06T13:22:33.339Z",
"authenticationMode": "Password",
"stores": []
}
Update actions
Change Email
action ​String​ | "changeEmail" |
email ​String​ | New value to set. |
{
"action": "changeEmail",
"email": "email@example.com"
}
Set First Name
action ​String​ | "setFirstName" |
firstName ​String​ | Value to set. If empty, any existing value is removed. |
{
"action": "setFirstName",
"firstName": "John"
}
Set Last Name
action ​String​ | "setLastName" |
lastName ​String​ | Value to set. If empty, any existing value is removed. |
{
"action": "setLastName",
"lastName": "Person"
}
Set Middle Name
action ​String​ | "setMiddleName" |
middleName ​String​ | Value to set. If empty, any existing value is removed. |
{
"action": "setMiddleName",
"middleName": "middleName"
}
Set Title
action ​String​ | "setTitle" |
title ​String​ | Value to set. If empty, any existing value is removed. |
{
"action": "setTitle",
"title": "Dr"
}
Set Salutation
action ​String​ | "setSalutation" |
salutation ​String​ | Value to set. If empty, any existing value is removed. |
{
"action": "setSalutation",
"salutation": "Mr"
}
Add Address
action ​String​ | "addAddress" |
address ​BaseAddress​ | Value to append to the addresses array. |
{
"action": "addAddress",
"address": {
"key": "exampleKey",
"title": "My Address",
"salutation": "Mr.",
"firstName": "Example",
"lastName": "Person",
"streetName": "Example Street",
"streetNumber": "4711",
"additionalStreetInfo": "Backhouse",
"postalCode": "80933",
"city": "Exemplary City",
"region": "Exemplary Region",
"state": "Exemplary State",
"country": "DE",
"company": "My Company Name",
"department": "Sales",
"building": "Hightower 1",
"apartment": "247",
"pOBox": "2471",
"phone": "+49 89 12345678",
"mobile": "+49 171 2345678",
"email": "email@example.com",
"fax": "+49 89 12345679",
"additionalAddressInfo": "no additional Info",
"externalId": "Information not needed"
}
}
Change Address
addressId
or addressKey
is required.action ​String​ | "changeAddress" |
addressId ​String​ | id of the Address to change. |
addressKey ​String​ | key of the Address to change. |
address ​BaseAddress​ | Value to set. |
{
"action": "changeAddress",
"addressId": "{{addressId}}",
"address": {
"key": "exampleKey",
"title": "My Address",
"salutation": "Mr.",
"firstName": "Example",
"lastName": "Person",
"streetName": "Example Street",
"streetNumber": "4711",
"additionalStreetInfo": "Backhouse",
"postalCode": "80933",
"city": "Exemplary City",
"region": "Exemplary Region",
"state": "Exemplary State",
"country": "DE",
"company": "My Company Name",
"department": "Sales",
"building": "Hightower 1",
"apartment": "247",
"pOBox": "2471",
"phone": "+49 89 12345678",
"mobile": "+49 171 2345678",
"email": "email@example.com",
"fax": "+49 89 12345679",
"additionalAddressInfo": "no additional Info",
"externalId": "Information not needed"
}
}
Remove Address
addressId
or addressKey
is required.Set Default Shipping Address
addresses
.
If the address is not currently a shipping address, it is added to shippingAddressIds
. Either addressId
or addressKey
is required.Add Shipping Address ID
addresses
array to shippingAddressIds
. Either addressId
or addressKey
is required.Remove Shipping Address ID
shippingAddressesIds
.
If the shipping address is the default shipping address, the defaultShippingAddressId
is unset. Either addressId
or addressKey
is required.Set Default Billing Address
addresses
.
If the address is not currently a billing address, it is added to billingAddressIds
. Either addressId
or addressKey
is required.Add Billing Address ID
addresses
array to billingAddressIds
. Either addressId
or addressKey
is required.Remove Billing Address ID
billingAddressesIds
.
If the billing address is the default billing address, the defaultBillingAddressId
is unset. Either addressId
or addressKey
is required.Set Company Name
companyName
field on the Customer produces the CustomerCompanyNameSet Message.action ​String​ | "setCompanyName" |
companyName ​String​ | Value to set. If empty, any existing value is removed. |
{
"action": "setCompanyName",
"companyName": "Company Ltd."
}
Set Date of Birth
action ​String​ | "setDateOfBirth" |
dateOfBirth ​Date​ | Value to set. If empty, any existing value is removed. |
{
"action": "setDateOfBirth",
"dateOfBirth": "2015-10-21"
}
Set Vat ID
action ​String​ | "setVatId" |
vatId ​String​ | Value to set. If empty, any existing value is removed. |
{
"action": "setVatId",
"vatId": "vatId"
}
Set Custom Type
action ​String​ | "setCustomType" |
type ​ | Defines the Type that extends the MyCustomer with Custom Fields.
If absent, any existing Type and Custom Fields are removed from the MyCustomer. |
fields ​ | Sets the Custom Fields fields for the MyCustomer. |
{
"action": "setCustomType",
"type": {
"id": "{{type-id}}",
"typeId": "type"
},
"fields": {
"exampleStringField": "TextString"
}
}
Set CustomField
action ​String​ | "setCustomField" |
name ​String​ | Name of the Custom Field. |
value ​ | If value is absent or null , this field will be removed if it exists.
If value is provided, it is set for the field defined by name .
Trying to remove a field that does not exist will fail with an InvalidOperation error. |
{
"action": "setCustomField",
"name": "exampleStringField",
"value": "TextString"
}
Set Locale
Change password of My Customer
reset=false
.manage_my_profile:{projectKey}
customer_id:{id}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
application/json
application/json
curl https://api.{region}.commercetools.com/{projectKey}/me/password -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA
{
"version" : 1,
"currentPassword" : "secret123",
"newPassword" : "newSecret456"
}
DATA
{
"id": "3cdcdcc8-80c5-41bb-abb5-ac8772c9cc24",
"version": 1,
"createdAt": "2022-09-19T14:34:35.843Z",
"lastModifiedAt": "2022-09-19T14:34:35.843Z",
"lastModifiedBy": {
"clientId": "P1Xf1NG2YsFqH2LC31oveDWT",
"isPlatformClient": false
},
"createdBy": {
"clientId": "P1Xf1NG2YsFqH2LC31oveDWT",
"isPlatformClient": false
},
"email": "johndoe@example.com",
"firstName": "John",
"lastName": "Doe",
"password": "****aGg=",
"addresses": [],
"shippingAddressIds": [],
"billingAddressIds": [],
"isEmailVerified": false,
"stores": [],
"authenticationMode": "Password"
}
Change password of My Customer in Store BETA
reset=false
. Returns a 200 OK
status if successful.- If no Customer exists with the
id
specified in the customer:{id} scope. - If the Customer exists but is associated with a different Store than what is specified in the
manage_my_profile:{projectKey}:{storeKey}
scope.
manage_my_profile:{projectKey}
manage_my_profile:{projectKey}:{storeKey}
customer_id:{id}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
storeKey String ​ | key of the Store. |
application/json
application/json
curl https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/me/password -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA
{
"version" : 1,
"currentPassword" : "secret123",
"newPassword" : "newSecret456"
}
DATA
{
"id": "3cdcdcc8-80c5-41bb-abb5-ac8772c9cc24",
"version": 1,
"createdAt": "2022-09-19T14:34:35.843Z",
"lastModifiedAt": "2022-09-19T14:34:35.843Z",
"lastModifiedBy": {
"clientId": "P1Xf1NG2YsFqH2LC31oveDWT",
"isPlatformClient": false
},
"createdBy": {
"clientId": "P1Xf1NG2YsFqH2LC31oveDWT",
"isPlatformClient": false
},
"email": "johndoe@example.com",
"firstName": "John",
"lastName": "Doe",
"password": "****aGg=",
"addresses": [],
"shippingAddressIds": [],
"billingAddressIds": [],
"isEmailVerified": false,
"stores": [],
"authenticationMode": "Password"
}
Reset password of My Customer
reset=true
.manage_my_profile:{projectKey}
customer_id:{id}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
application/json
application/json
curl https://api.{region}.commercetools.com/{projectKey}/me/password/reset -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA
{
"tokenValue" : "VRndRV5oCr-pKH2360DnlhqEOVVUZXSAIUXgT5HL",
"newPassword" : "newsecret123"
}
DATA
{
"id": "3cdcdcc8-80c5-41bb-abb5-ac8772c9cc24",
"version": 1,
"createdAt": "2022-09-19T14:34:35.843Z",
"lastModifiedAt": "2022-09-19T14:34:35.843Z",
"lastModifiedBy": {
"clientId": "P1Xf1NG2YsFqH2LC31oveDWT",
"isPlatformClient": false
},
"createdBy": {
"clientId": "P1Xf1NG2YsFqH2LC31oveDWT",
"isPlatformClient": false
},
"email": "johndoe@example.com",
"firstName": "John",
"lastName": "Doe",
"password": "****aGg=",
"addresses": [],
"shippingAddressIds": [],
"billingAddressIds": [],
"isEmailVerified": false,
"stores": [],
"authenticationMode": "Password"
}
Reset password of My Customer in Store BETA
reset=true
.- If no Customer exists with the
id
specified in the customer:{id} scope. - If the Customer exists but is associated with a different Store than what is specified in the
manage_my_profile:{projectKey}:{storeKey}
scope.
manage_my_profile:{projectKey}
manage_my_profile:{projectKey}:{storeKey}
customer_id:{id}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
storeKey String ​ | key of the Store. |
application/json
application/json
curl https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/me/password/reset -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA
{
"tokenValue" : "VRndRV5oCr-pKH2360DnlhqEOVVUZXSAIUXgT5HL",
"newPassword" : "newsecret123"
}
DATA
{
"id": "3cdcdcc8-80c5-41bb-abb5-ac8772c9cc24",
"version": 1,
"createdAt": "2022-09-19T14:34:35.843Z",
"lastModifiedAt": "2022-09-19T14:34:35.843Z",
"lastModifiedBy": {
"clientId": "P1Xf1NG2YsFqH2LC31oveDWT",
"isPlatformClient": false
},
"createdBy": {
"clientId": "P1Xf1NG2YsFqH2LC31oveDWT",
"isPlatformClient": false
},
"email": "johndoe@example.com",
"firstName": "John",
"lastName": "Doe",
"password": "****aGg=",
"addresses": [],
"shippingAddressIds": [],
"billingAddressIds": [],
"isEmailVerified": false,
"stores": [],
"authenticationMode": "Password"
}
Verify email of My Customer
manage_my_profile:{projectKey}
customer_id:{id}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
application/json
application/json
curl https://api.{region}.commercetools.com/{projectKey}/me/email/confirm -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA
{
"tokenValue" : "hI_6fkuFIyd_wadz1JmpRGh1vMvgFrlsSJia3G6d"
}
DATA
{
"id": "3cdcdcc8-80c5-41bb-abb5-ac8772c9cc24",
"version": 1,
"createdAt": "2022-09-19T14:34:35.843Z",
"lastModifiedAt": "2022-09-19T14:34:35.843Z",
"lastModifiedBy": {
"clientId": "P1Xf1NG2YsFqH2LC31oveDWT",
"isPlatformClient": false
},
"createdBy": {
"clientId": "P1Xf1NG2YsFqH2LC31oveDWT",
"isPlatformClient": false
},
"email": "johndoe@example.com",
"firstName": "John",
"lastName": "Doe",
"password": "****aGg=",
"addresses": [],
"shippingAddressIds": [],
"billingAddressIds": [],
"isEmailVerified": false,
"stores": [],
"authenticationMode": "Password"
}
Verify email of My Customer in Store BETA
200 OK
status if successful.- If no Customer exists with the
id
specified in the customer:{id} scope. - If the Customer exists but is associated with a different Store than what is specified in the
manage_my_profile:{projectKey}:{storeKey}
scope.
manage_my_profile:{projectKey}
manage_my_profile:{projectKey}:{storeKey}
customer_id:{id}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
storeKey String ​ | key of the Store. |
application/json
application/json
curl https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/me/email/confirm -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA
{
"tokenValue" : "hI_6fkuFIyd_wadz1JmpRGh1vMvgFrlsSJia3G6d"
}
DATA
{
"id": "3cdcdcc8-80c5-41bb-abb5-ac8772c9cc24",
"version": 1,
"createdAt": "2022-09-19T14:34:35.843Z",
"lastModifiedAt": "2022-09-19T14:34:35.843Z",
"lastModifiedBy": {
"clientId": "P1Xf1NG2YsFqH2LC31oveDWT",
"isPlatformClient": false
},
"createdBy": {
"clientId": "P1Xf1NG2YsFqH2LC31oveDWT",
"isPlatformClient": false
},
"email": "johndoe@example.com",
"firstName": "John",
"lastName": "Doe",
"password": "****aGg=",
"addresses": [],
"shippingAddressIds": [],
"billingAddressIds": [],
"isEmailVerified": false,
"stores": [],
"authenticationMode": "Password"
}
Delete My Customer
200 OK
status if successful.manage_my_profile:{projectKey}
customer_id:{id}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
version Int ​ | Last seen version of the resource. |
application/json
curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/me?version={version} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"
{
"id": "3cdcdcc8-80c5-41bb-abb5-ac8772c9cc24",
"version": 1,
"createdAt": "2022-09-19T14:34:35.843Z",
"lastModifiedAt": "2022-09-19T14:34:35.843Z",
"lastModifiedBy": {
"clientId": "P1Xf1NG2YsFqH2LC31oveDWT",
"isPlatformClient": false
},
"createdBy": {
"clientId": "P1Xf1NG2YsFqH2LC31oveDWT",
"isPlatformClient": false
},
"email": "johndoe@example.com",
"firstName": "John",
"lastName": "Doe",
"password": "****aGg=",
"addresses": [],
"shippingAddressIds": [],
"billingAddressIds": [],
"isEmailVerified": false,
"stores": [],
"authenticationMode": "Password"
}
Delete My Customer in Store BETA
200 OK
status if successful.- If no Customer exists with the
id
specified in the customer:{id} scope. - If the Customer exists but is associated with a different Store than what is specified in the
manage_my_profile:{projectKey}:{storeKey}
scope.
manage_my_profile:{projectKey}
manage_my_profile:{projectKey}:{storeKey}
customer_id:{id}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
storeKey String ​ | key of the Store. |
version Int ​ | Last seen version of the resource. |
application/json
curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/me?version={version} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"
{
"id": "3cdcdcc8-80c5-41bb-abb5-ac8772c9cc24",
"version": 1,
"createdAt": "2022-09-19T14:34:35.843Z",
"lastModifiedAt": "2022-09-19T14:34:35.843Z",
"lastModifiedBy": {
"clientId": "P1Xf1NG2YsFqH2LC31oveDWT",
"isPlatformClient": false
},
"createdBy": {
"clientId": "P1Xf1NG2YsFqH2LC31oveDWT",
"isPlatformClient": false
},
"email": "johndoe@example.com",
"firstName": "John",
"lastName": "Doe",
"password": "****aGg=",
"addresses": [],
"shippingAddressIds": [],
"billingAddressIds": [],
"isEmailVerified": false,
"stores": [],
"authenticationMode": "Password"
}