Document Properties
Kbid29599G
Last Modified02-Nov-2020
Added to KB03-Sep-2020
Public AccessEveryone
StatusOnline
Doc TypeReferences
ProductICM 7.10

Reference - ICM REST API - B2B Front End - Newsletter (Subscription) 1.0.0


Product Version

7.10

Product To Version


Status

final

Download Specification 

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

API Specification

Introduction

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

This is Intershop ICM REST API documentation.

This reference lists the REST API for storefront development. The REST API covers features of both, the B2C (SMB - Small and Medium-sized businesses) and the B2B storefront development.
This reference is intended for developers who want to make use of an easy-to-use API when developing frontend solutions.
You can find more information at Intershop Communications. Contact our Intershop experts at Support - Intershop Communications

Introduction

This API is documented in OpenAPI format.

Subscription (E-Mail Marketing) API

/subscriptions
POST: Subscribes a recipient, with an e-mail, to the e-mail marketing provider configured for the application

Description

A subscriber, represented with an e-mail in the request body, is subscribed 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

400 - Bad Request

possible values for header error-key:
- subscriptions.recipient.invalid.error
- subscriptions.recipient.missing.error

404 - Not Found

possible values for header error-key:
- subscriptions.provider_not_found.error

409 - Conflict

possible values for header error-key:
- subscriptions.recipient.missing.error

500 - Internal Server Error

possible values for header error-key:
- subscriptions.external_service.error
/subscriptions/{SubscriptionResourceKey}
GET: Shows subscription status for given recipient

Description

This URI could be accessed with either authentication header or not. If such header, with valid credentials, is sent from the client and the sub resource is "-", e. g., /subscriptions/-, then the recipient e-mail will be taken from the user which credentials are sent.
If valid e-mail addresses is used as sub resource name, e. g., /subscriptions/patricia@test.intershop.de, then this e-mail address will be checked for subscription entries in the subscription's provider.
Whichever recipient's e-mail is used 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

LocationNameFormatDescription
in pathSubscriptionResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

SubscriptionRO application/json

404 - Not Found

possible values for header error-key:
- subscriptions.subscription_not_found.error

500 - Internal Server Error

possible values for header error-key:
- subscriptions.external_service.error
DELETE: Unsubscripe recipient from an e-mail provider

Description

This URI could be accessed with either authentication header or not. If such header, with valid credentials, is sent from the client and the sub resource is "-", e. g., /subscriptions/-, then the recipient e-mail will be taken from the user which credentials are sent.
If valid e-mail addresses is used as sub resource name, e. g., /subscriptions/patricia@test.intershop.de, then this e-mail address will be checked for subscription entries in the subscription's provider.
Whichever recipient's e-mail is used 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

LocationNameFormatDescription
in pathSubscriptionResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

204 - No Content

400 - Bad Request

404 - Not Found

possible values for header error-key:
- subscriptions.subscription_not_found.error

500 - Internal Server Error

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 object. This is normally a constant that can be used to differentiate objects by their type. | Example: Subscription
  • "active":
    boolean
    a boolean value indicating if the subscription is active
  • "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.

Customer Support
Knowledge Base
Product Resources
Tickets