Document Properties
Kbid
29599G
Last Modified
09-Nov-2022
Added to KB
03-Sep-2020
Public Access
Everyone
Status
Online
Doc Type
References
Product
  • ICM 7.10
  • ICM 11
Reference - Newsletter (Subscription) REST API 1.0.0
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 7.10 and their version dependencies:

API Specification

Introduction
OpenAPI Version: 3.0.1
Newsletter Subscription (E-Mail Marketing) Version: 1.0.0

The Intershop Newsletter Subscription API contains operations that allow to retrieve, delete and update e-mail marketing subscription information of a recipient.

Subscription (E-Mail Marketing) API

The following operations for managing e-mail marketing subscriptions are available:

/subscriptions
POST: Subscribes a recipient

Description

This operation subscribes a recipient (represented by an e-mail address in the request body) to the e-mail marketing provider specified for the application.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.subscription.SubscriptionsResource.subscribe(com.intershop.sellside.rest.common.capi.resourceobject.subscription.SubscriptionRO)

Request Body

SubscriptionRO application/json

Request Parameters

--

Response

201 - Created - The user was successfully subscribed.

400 - Bad Request - The recipient is empty or invalid.
Possible values for header error-key:
- subscriptions.recipient.invalid.error
- subscriptions.recipient.missing.error

404 - Not Found - Currently there is no provider for subscription handling available.
Possible values for header error-key:
- subscriptions.provider_not_found.error

409 - Conflict - The recipient is already subscribed.
Possible values for header error-key:
- subscriptions.recipient.missing.error

500 - Internal Server Error - An error occured during user mail lookup or while converting data.
Possible values for header error-key:
- subscriptions.external_service.error

/subscriptions/{SubscriptionResourceKey}
GET: Returns subscription status for given recipient

Description

This operation returns the subscription status of a given recipient based on the account data.
Only users with an account can access their subscription status using this REST resource.

This URI can only be accessed with an authentication header. If a valid e-mail address is used as sub resource name, e. g., /subscriptions/patricia@test.intershop.de, this e-mail address is checked for subscription entries in the subscription's provider.

If the sub resource is "-", e. g., /subscriptions/-, then the e-mail address of the authenticated user is applied.

The response status codes will be 200 OK, if the recipient is subscribed, or 404 Not Found, if they are not.

This resource depends on back office configuration for e-mail marketing provider. If no such provider is configured, it will respond with 404 Not Found.

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.subscription.SubscriptionRO com.intershop.sellside.rest.common.capi.resource.subscription.SubscriptionResource.getStatus()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathSubscriptionResourceKeystringd.weiers@test.intershop.deRequired | The recipient's e-mail address or "-" for an authenticated user

Response

200 - OK - The subscription for the given user.

SubscriptionRO application/json

404 - Not Found - The user is not subscribed.
Possible values for header error-key:
- subscriptions.subscription_not_found.error

500 - Internal Server Error - An error occured during user mail lookup.
Possible values for header error-key:
- subscriptions.external_service.error

DELETE: Unsubscribes recipient from e-mail provider

Description

This operation unsubscribes a recipient from an e-mail provider based on the account data.
Users without an account must use the provided contact information to unsubscribe.

This URI can only be accessed with an authentication header. If a valid e-mail address is used as sub resource name, e. g., /subscriptions/patricia@test.intershop.de, this e-mail address is checked for subscription entries in the subscription's provider.

If the sub resource is "-", e. g., /subscriptions/-, then the e-mail address of the authenticated user is applied.

The response status codes will be 200 OK, if the recipient is subscribed, or 404 Not Found, if they are not.

This resource depends on back office configuration for e-mail marketing provider. If no such provider is configured, it will respond with 404 Not Found.

Java Method

public void com.intershop.sellside.rest.common.capi.resource.subscription.SubscriptionResource.unsubscribe()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathSubscriptionResourceKeystringd.weiers@test.intershop.deRequired | The recipient's e-mail address or "-" for an authenticated user

Response

204 - No Content - The user was successfully unsubscribed.

404 - Not Found - The user is not subscribed.
Possible values for header error-key:
- subscriptions.subscription_not_found.error

500 - Internal Server Error - An error occured during user mail lookup.
Possible values for header error-key:
- subscriptions.external_service.error

Request and Response Object Schemata
SubscriptionRO application/json{
  • "name":
    string
    The name of an element
  • "type":
    string
    The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: Subscription
  • "active":
    boolean
    A boolean value indicating whether the subscription is active | Example: true
  • "recipient":
    string
    The recipient of the newsletter | Example: d.weiers@test.intershop.de
}
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.