Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Elastic Path Personal Data Erasure Requests API

Erasure requests enable you to exercise the right, referred to in regulations such as GDPR, as the right to beforgotten or right to erase.Erasure requests allow you to wipe out personal data from Commerce in an automated way, including:* All related resources (for example, addresses, customers, and so on.)* Personal Data LogsErasure requests can be created for any data entry in the personal data set (see [Personal Data Concept](/docs/api/personal-data/personal-data-introduction) for details), and the result is the same.:::noteCurrently, it does not include flows or data external to Commerce.:::Erasure requests are processed asynchronously. The POST requests return immediately, and processing continues inthe background. You can use the GET endpoint to poll for results until you see `{..."status":"SUCCESS"...}` in theresponse body.In the unlikely event an erasure request fails (if the status is not equal to `SUCCESS`), you are advised to retryby creating another erasure request. If the problem persists, contact Support.:::noteCurrently, personal data management is only enabled for a limited set of endpoints. Seethe [personal data concepts page](/docs/api/personal-data/personal-data-introduction) for the list of endpoints that support personal datamanagement.:::Seller Admin & IT users have full access to Erasure Requests, and Support users have read access.

Elastic Path Personal Data Erasure Requests API is one of 100 APIs that Elastic Path publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Personal Data Erasure Requests. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 25.1126.6886238.

Requests are made against 2 base URLs: https://useast.api.elasticpath.com, https://euwest.api.elasticpath.com.

3 operations 2 paths 6 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
25.1126.6886238
Base URL
https://useast.api.elasticpath.com
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

Elastic Path Personal Data Erasure Requests API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerToken). By default, every request must be authenticated.

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Personal Data Erasure Requests 3

Erasure requests enable you to exercise the right, referred to in regulations such as GDPR, as the right to be forgotten or right to erase. Erasure requests allow you to wipe out…

POST
/v2/personal-data/erasure-requests
Create Personal Data Erasure Request
post-erasure-request body → 201400default
GET
/v2/personal-data/erasure-requests
Get all Personal Data Erasure Request
get-erasure-requests 3 params → 200401default
GET
/v2/personal-data/erasure-requests/{erasure_request_id}
Get Personal Data Erasure Request
get-erasure-request 1 param → 200404default

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are ErasureRequestResponse (10 properties), PaginationLinks (5 properties), ErasureRequest (3 properties), Error (3 properties). Each schema is shown below with its type and property counts.

ErasureRequestResponse
object
10 properties
ErrorResponse
object
1 property 1 required
Error
object
3 properties 2 required
ErasureRequest
object
3 properties
PaginationMeta
object
2 properties 2 required
PaginationLinks
object
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-path-personal-data-erasure-requests-api-openapi.yml Raw ↑

Other APIs Elastic Path publishes across the network.

Elastic Path GraphQL API
Elastic Path Account Addresses API
Elastic Path Account Authentication Settings API
Elastic Path Account Cart Associations API
Elastic Path Account Management Authentication API
Elastic Path Account Members API
Elastic Path Account Membership API
Elastic Path Account Membership Settings API
Elastic Path Account Tags API
Elastic Path Accounts API
Elastic Path Administrator Latest Releases Catalog API API
Elastic Path Application Keys API