VTEX · Example Payload

Vtex Post Apiuser Rightscreateandprocessdeleteuserdata Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Post Apiuser Rightscreateandprocessdeleteuserdata Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

{
  "operationId": "post-apiuser-rightscreateandprocessdeleteuserdata",
  "method": "POST",
  "path": "/api/user-rights/createAndProcessDeleteUserData",
  "summary": "VTex Erase customer data",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "uuid": "3e2f53dc-b099-4dc8-9727-581b2a97f39c",
        "requestType": "Removal",
        "email": "pedido2@vtexchallenge.com",
        "status": "Completed",
        "dataResponse": "{\r\n  \"VTEX  Checkout\": [],\r\n  \"orders\": {\r\n    \"dataStatus\": {\r\n      \"status\": \"anonymized\",\r\n      \"reason\": \"Sensitive information was anonymized rather than deleted to preserve the store metrics.\",\r\n      \"evidence\": \"Anonymized [0] orders\",\r\n      \"dryRun\": true\r\n    },\r\n    \"orders\": []\r\n  },\r\n  \"Profile System PII API\": {},\r\n  \"VTEX ID\": {\r\n    \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.5.4\",\r\n    \"title\": \"Not Found\",\r\n    \"status\": 404,\r\n    \"traceId\": \"00-65d5abf9263b07eb185beee49e2075dc-b67b373e2e93dcf8-00\"\r\n  }\r\n}",
        "requestTime": "2023-09-05T17:19:33.1969022-03:00",
        "applications": [
          {
            "application": "chk",
            "status": "Deleted",
            "errorDetail": "",
            "updateAt": "2023-09-05T20:20:23"
          },
          {
            "application": "orders",
            "status": "Deleted",
            "errorDetail": "",
            "updateAt": "2023-09-05T20:20:25"
          },
          {
            "application": "profileSystemV2",
            "status": "Deleted",
            "errorDetail": "",
            "updateAt": "2023-09-05T20:20:26"
          },
          {
            "application": "vid",
            "status": "Deleted",
            "errorDetail": "",
            "updateAt": "2023-09-05T20:20:29"
          }
        ]
      }
    }
  ]
}