Manage orders (synchronous API)

Request PII removal for a customer using the given order ID

Request the removal of a customer's Personally Identifiable Information (PII) by providing the order ID.

POSThttps://api.digitalriver.com/v1/orders/{orderId}/requestPIIRemoval

Authorization

SystemApiKeyOnly

Path parameters

orderId*string

The order's ID.

Response

200400401403404

Successful response.

Body

application/json

piiRemovalResponseobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/orders/{orderId}/requestPIIRemoval', {
    method: 'POST',
    headers: {
      "Authorization": "basic <token>"
    },
});
const data = await response.json();

Response

200400403404

{
  "piiRemovalResponse": {
    "message": "Due to Digital River's legal and business obligations globally, we need to retain personal data for a defined period of time. Personal data will be removed once this period expires per our data retention policy.",
    "status": "received"
  }
}