This API specification is available for download as an Open API 3.0 YAML file:
/subscriptions
A subscriber, represented with an e-mail in the request body, is subscribed to the e-mail marketing provider specified for the application.
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)
201 - Created
400 - Bad Request
404 - Not Found
409 - Conflict
500 - Internal Server Error
/subscriptions/{SubscriptionResourceKey}
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.
public com.intershop.sellside.rest.common.capi.resourceobject.subscription.SubscriptionRO com.intershop.sellside.rest.common.capi.resource.subscription.SubscriptionResource.getStatus()
Location | Name | Format | Description |
---|---|---|---|
in path | SubscriptionResourceKey | string | Required | The key or UUID to resolve a single item | Example: ExampleKey |
200 - OK
404 - Not Found
500 - Internal Server Error
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.
public void com.intershop.sellside.rest.common.capi.resource.subscription.SubscriptionResource.unsubscribe()
Location | Name | Format | Description |
---|---|---|---|
in path | SubscriptionResourceKey | string | Required | The key or UUID to resolve a single item | Example: ExampleKey |
204 - No Content
400 - Bad Request
404 - Not Found
500 - Internal Server Error
Subscription
d.weiers@test.intershop.de
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.