Anonymize customer

General

SCAYLE allows you to anonymize a customer by its reference key or ID, which is important when your system must comply with the active data protection laws.

Admin API

This method can be used to anonymize an existing customer with its dependencies (e.g., addresses) in accordance with the active data protection laws. The customer's orders remain intact.

Anonymize customer (deprecated)

JavaScriptPHPcURLJava

Copy

adminApi.apis.Customers.anonymizeCustomer({shopKey: shopKey, countryCode: countryCode, customerIdentifier: customerIdentifier});

Anonymize by ID

Anonymize a customer by id:

JavaScriptPHPcURLJava

Copy

adminApi.apis.Customers.anonymizeCustomer({shopKey: 'ms', countryCode: 'DE', customerIdentifier: 1});

Anonymize by Reference Key

Anonymize a customer by reference key.

JavaScriptPHPcURLJava

Copy

adminApi.apis.Customers.anonymizeCustomer({shopKey: 'ms', countryCode: 'DE', customerIdentifier: "key=my-key"});

Delete customer

This endpoint can be used to delete (anonymize) a customer along with its dependencies (except for the customer's orders) in accordance with data protection acts. When sending this request, the customer data will get anonymized ("soft-deleted") for a certain amount of time. The deletion process can be reversed during this period (See Cancel queued deletion). After that time, the customer will be completely deleted without possibility to restore.

JavaScriptPHPcURLJava

Copy

adminApi.apis.Customers.delete({shopKey: shopKey, countryCode: countryCode, customerIdentifier: customerIdentifier});

Delete by ID

Delete a customer by id:

JavaScriptPHPcURLJava

Copy

adminApi.apis.Customers.delete({shopKey: 'ms', countryCode: 'DE', customerIdentifier: 1});

Delete by Reference Key

Delete a customer by reference key.

JavaScriptPHPcURLJava

Copy

adminApi.apis.Customers.delete({shopKey: 'ms', countryCode: 'DE', customerIdentifier: "key=my-key"});

Cancel queued deletion

The action to restore the queued deletion of the customer (in the first 6 months after the request to delete)

JavaScriptPHPcURLJava

Copy

adminApi.apis.Customers.cancelAnonymization({shopKey: shopKey, countryCode: countryCode, customerIdentifier: customerIdentifier});

Cancel queued deletion by ID

Cancel customer queued deletion by id:

JavaScriptPHPcURLJava

Copy

adminApi.apis.Customers.cancelAnonymization({shopKey: 'ms', countryCode: 'DE', customerIdentifier: 1});

Cancel queued deletion by by Reference Key

Cancel customer queued deletion by reference key.

JavaScriptPHPcURLJava

Copy

adminApi.apis.Customers.cancelAnonymization({shopKey: 'ms', countryCode: 'DE', customerIdentifier: "key=my-key"});

Anonymize customer addresses

SCAYLE allows you to anonymize a customer address, which is important when your system must comply with the active data protection laws. When referring to the address, you need to use its reference key of ID. The address has already been anonymized if the respective customer has been anonymized previously.

This method can be used to anonymize an existing customer address in accordance with data protection laws. The address will not be removed from existing confirmed orders.

Copy

When you call this endpoint to anonymize an address,
the customer's addresses detected as duplicates will get anonymized as well.

Method Signature

JavaScriptPHPcURLJava

Copy

adminApi.apis.Customers.anonymizeAddressByIdentifier({shopKey: shopKey, countryCode: countryCode, addressIdentifier: addressIdentifier});

Anonymize by ID

Anonymize a customer address by id:

JavaScriptPHPcURLJava

Copy

adminApi.apis.Customers.anonymizeCustomerAddress({shopKey: 'ms', countryCode: 'DE', addressIdentifier: 123});

Anonymize by Reference Key

Anonymize a customer address by reference key:

JavaScriptPHPcURLJava

Copy

adminApi.apis.Customers.anonymizeCustomerAddress({shopKey: "ms", countryCode: "DE", addressIdentifier: "key=my-key-123"});