- Menu
- Sitemap
- ICM 7.7
- ICM 7.8
- ICM 7.9
- ICM 7.10
REST API - Shows subscription status for given recipient
Note
Starting with Intershop 7.10 our REST API is provided in the Open API 3.0 format, see Reference - Intershop Commerce Management REST API 7.10.
URI | /subscriptions/<recipient's email or "-" for authenticated user> |
|---|---|
Http Method | GET |
Short Description | Response of this URI will contain information about subscription status of given recipient to the e-mail provider configured for the application |
Query Parameters | N/A |
Example Requests | /subscriptions/patricia@test.intershop.de /subscriptions/- |
HTTP Status Codes | 200 OK 404 Not Found Possible values for header error-key:
500 Internal Server Error Possible values for header error-key:
|
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. |
Cartridge | app_sf_rest |
| Application | B2C Web Shop, SMB Web Shop |
Product Version | 7.4 |
|---|---|
Product To Version | |
| Status | final |
JSON
Request Data Format | |
|---|---|
Request related java object | |
Request Example | |
Response Data Format | application/json |
Response related java object | com.intershop.sellside.rest.common.capi.resource.subscription.SubscriptionsResource com.intershop.sellside.rest.common.capi.resourceobject.subscription.SubscriptionRO |
Response Example | {
"type": "Subscription",
"active": true
}
|
XML
XML Request Data Format | |
|---|---|
XML Request Java Objects | |
XML Request Example | |
XML Response Data Format | |
XML Response Java Objects | com.intershop.sellside.rest.common.capi.resource.subscription.SubscriptionsResource com.intershop.sellside.rest.common.capi.resourceobject.subscription.SubscriptionRO |
XML Response Example | <Subscription type="Subscription">
<active>true</active>
</Subscription>
|
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.