Document Tree
Document Properties
Kbid
31A012
Last Modified
22-Sep-2023
Added to KB
21-Sep-2023
Public Access
Everyone
Status
Online
Doc Type
References
Product
ICM 11
Reference - GDPR REST API 1.0.1 (ICM 11)
Document View


This API specification is available for download as an Open API 3.0 YAML file: 

References

The following page lists available REST APIs for ICM 11 and their version dependencies:

API Specification

Introduction
OpenAPI Version: 3.0.1
GDPR Version: 1.0.1

The GDPR REST API contains resources to handle personal data requests.

API Versioning & Accept-Header

Media-type-based versioning is used to distinguish between different API versions. For requests to the GDPR REST API v1, the REST client must set the following HTTP Accept header:

Accept: application/vnd.intershop.gdpr.v1+json

Confirmation API

This section covers operations for confirmation of an GDPR data request.

/gdpr-requests/{request-id}/confirmations
PUT: Confirm GDPR request

Description

This confirms a GDPR data request given by its ID. The call is verified by the hash value only known to the receiver of the confirmation e-mail. The data request can be technically repeated as long as the resource is valid. In that case the info code
'gdpr_request.confirmation.info' is returned, otherwise 'gdpr_request.already_confirmed.info'. A 404 is returned when the request could not be found. Should the verification of the hash values fail the response code 422 is returned.

Java Method

public jakarta.ws.rs.core.Response com.intershop.sellside.rest.gdpr.v1.capi.resource.gdpr.confirmation.GdprConfirmationListResource.confirmGDPRRequest(com.intershop.sellside.rest.gdpr.v1.capi.resourceobject.GdprRequestConfirmationRO)

Request Body

GdprRequestConfirmationRO application/json

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathrequest-idstringRequired

Response

200 - OK - The confirmation of the data request was successful.

GdprContainerRO_v1 application/vnd.intershop.gdpr.v1+json

404 - Not Found - No active data request found with given parameters.

GdprContainerRO_v1 application/vnd.intershop.gdpr.v1+json

422 - Unprocessable Entity - Data request hash is invalid.

GdprContainerRO_v1 application/vnd.intershop.gdpr.v1+json
Request and Response Object Schemata
GdprContainerRO_v1 application/vnd.intershop.gdpr.v1+json{
  • "data":
    object
    A GdprRequestConfirmationRO object. A representation of a data request confirmation
    {
    • "hash":
      string
      The hash value to verify the relation to corresponding data request. | Example: df25a3b0-6744-4cab-a70e-dedafc47ae42
    }
  • "errors":
    array
    Readonly | An array of FeedbackRO_v1 objects. List of errors that occurred in relation to the request.
    [
    FeedbackRO_v1: An error or information representation regarding the current request.
    {
    • "causes":
      array
      An array of FeedbackCauseRO_v1 objects. A collection of errors/infos that caused this feedback.
      [
      FeedbackCauseRO_v1: A representation for the common feedback informations.
      {
      • "code":
        string
        Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
      • "message":
        string
        Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
      • "parameters":
        object
        A map of several parameters that are used to assemble the message.
      • "paths":
        array
        An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
      }
      ]
    • "code":
      string
      Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
    • "message":
      string
      Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
    • "parameters":
      object
      A map of several parameters that are used to assemble the message.
    • "paths":
      array
      An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
    • "status":
      string
      The HTTP status code, that is applicable to this problem. | Example: 400
    }
    ]
  • "included":
    object
    Optionally included related data objects.
  • "infos":
    array
    Readonly | An array of FeedbackRO_v1 objects. List of informations regarding to the request (e.g. value adjustments).
    [
    FeedbackRO_v1: An error or information representation regarding the current request.
    {
    • "causes":
      array
      An array of FeedbackCauseRO_v1 objects. A collection of errors/infos that caused this feedback.
      [
      FeedbackCauseRO_v1: A representation for the common feedback informations.
      {
      • "code":
        string
        Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
      • "message":
        string
        Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
      • "parameters":
        object
        A map of several parameters that are used to assemble the message.
      • "paths":
        array
        An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
      }
      ]
    • "code":
      string
      Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
    • "message":
      string
      Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
    • "parameters":
      object
      A map of several parameters that are used to assemble the message.
    • "paths":
      array
      An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
    • "status":
      string
      The HTTP status code, that is applicable to this problem. | Example: 400
    }
    ]
  • "links":
    object
    Readonly | Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.
}
GdprRequestConfirmationRO application/json{
  • "hash":
    string
    The hash value to verify the relation to corresponding data request. | Example: df25a3b0-6744-4cab-a70e-dedafc47ae42
}
Disclaimer
The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.
The Intershop Knowledge Portal uses only technically necessary cookies. We do not track visitors or have visitors tracked by 3rd parties. Please find further information on privacy in the Intershop Privacy Policy and Legal Notice.
Home
Knowledge Base
Product Releases
Log on to continue
This Knowledge Base document is reserved for registered customers.
Log on with your Intershop Entra ID to continue.
Write an email to supportadmin@intershop.de if you experience login issues,
or if you want to register as customer.