- Menu
- Sitemap
Reference - Newsletter (Subscription) API 1.0.0
Download Specification
This API specification is available for download as an Open API 3.0 YAML file:
API Specification
Introduction
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
- subscriptions.recipient.invalid.error
- subscriptions.recipient.missing.error
404 - Not Found
- subscriptions.provider_not_found.error
409 - Conflict
- subscriptions.recipient.missing.error
500 - Internal Server Error
- 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
| Location | Name | Format | Description |
|---|---|---|---|
| in path | SubscriptionResourceKey | string | Required | The key or UUID to resolve a single item | Example: ExampleKey |
Response
200 - OK
SubscriptionRO application/json
404 - Not Found
- subscriptions.subscription_not_found.error
500 - Internal Server Error
- 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
| Location | Name | Format | Description |
|---|---|---|---|
| in path | SubscriptionResourceKey | string | Required | The key or UUID to resolve a single item | Example: ExampleKey |
Response
204 - No Content
400 - Bad Request
404 - Not Found
- subscriptions.subscription_not_found.error
500 - Internal Server Error
- subscriptions.external_service.error
Request and Response Object Schemata
SubscriptionRO application/json
{- "name":stringThe name of an element.
- "type":stringThe type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example:
Subscription - "active":booleana boolean value indicating if the subscription is active
- "recipient":stringthe 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.