Guest delete data model

The method of identifying guests varies per organization. Some organizations only use identifiers to determine identity, such as provider and id. Other organizations only use guest attributes to identify a guest such as firstName, lastName, and email. Of these organizations, the number of guest attributes required to perform identity is optional, but there must be enough guest attributes provided for potential matching guest records to be identified. For example, firstName and lastName do not provide enough identifying information to match a guest record for deletion.

There are two available modes for deleting a guest:

• delete mode - deletes the guest profile and the associated sessions and events, but not the associated orders and order items. To delete the orders and order items, you must first delete the orders using the Batch API order delete endpoint, before using delete mode.
• gdpr_delete mode - deletes the guest profile and all associated entities including sessions, events, orders, and order items.

Guests have a right to be forgotten and you must use the gdpr_delete mode if you are deleting the guest in order to meet GDPR compliance.

When you create a batch file, ensure that you include all required attributes in addition to any attributes from the following table:

Here's a JSON example that uses identifiers to identify a guest:

{
  "ref": "17AC5C03-F7A1-461F-A3B1-C96F43143522",
  "schema": "guest",
  "mode": "delete",
  "value": {
    "identifiers": [
      {
        "provider": "IDENTITY_SYSTEM",
        "id": "BX_201504"
      }
    ]
  }
}

Here's a JSON example that uses Personally Identifiable Identifiers (PII) to identify a guest:

{
   "ref":"17AC5C03-F7A1-461F-A3B1-C96F43143522",
   "schema":"guest",
   "mode":"delete",
   "value":{
      "email":"[email protected]",
      "firstName":"John",
      "lastName":"Doe"
   }
}