References

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

Reference - Intershop Commerce Management 7.10 REST API

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

GDPR API

/gdpr-requests/{request-id}/confirmations

PUT: Confirmation of a data request with the given ID.

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 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 javax.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

Location	Name	Format	Default	Example	Description
in path	request-id	string			Required

Response

200 - OK The data request has already been successfully confirmed.

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 identify the corresponding data request.
}
"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 identify the corresponding data request.

}

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.