REST API for Oracle Commerce Cloud December 2017

getEmailNotificationTypes

get

/ccadmin/v1/email/notificationTypes

Get Email Notification Types. Get the email notification types.

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getEmailNotificationTypes_response

Properties

items: Type: array items

Additional Properties Allowed:

Email notification types

Nested Schema : items

Type: array

Email notification types

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

description: Type: string

email notification description - usually null
displayName: Type: string

email notification display name
enabled: Type: boolean

true - this notification is enabled and an email will be sent out, false - disable no email sent when triggered
fromEmail: Type: string

from email address
fromName: Type: string

from name
id: Type: string

key
includeRecommendations: Type: boolean

true - product recommendations will be included in the email, false - product recommendations will not be included in the email
numberOfRecommendations: Type: integer

Number of product recommendations to include in email
recommendationsAllowAnyStrategy: Type: boolean

true - any recommendations strategy (e.g. Blended, Top Sellers, Bought Together, Browsed Together) can be used, false - only specific recommendation strategies are permitted
recommendationsAllowRestrictions: Type: boolean

true - allow restrictions (such as 'in-brand' or 'in-category' to be applied to the recommendation strategy, false - don't allow restrictions to be applied to the recommendation strategy
recommendationsPermittedStrategies: Type: array recommendationsPermittedStrategies

Additional Properties Allowed:

Array of recommendation strategy keys permitted for this notification type
recommendationsRestriction: Type: string

The recommendations restriction
recommendationsStrategy: Type: string

The recommendations strategy
recommendationsSupported: Type: boolean

true - product recommendations are supported, false - product recommendations are not supported
verificationStatus: Type: integer

0 - Not applicable (BASIC/SMTP) 1 - Status not verified,2 - Status pending verification or 3 Status Verified
version: Type: integer

email notification version - usually 1

Nested Schema : recommendationsPermittedStrategies

Type: array

Array of recommendation strategy keys permitted for this notification type

Items

Type: string

Example application/json


{
    "forgotPassword":{
        "recommendationsSupported":false,
        "verificationStatus":1,
        "displayName":"Forgot Password Email",
        "recommendationsStrategy":null,
        "enabled":true,
        "fromEmail":"info@slc04lxz.us.oracle.com",
        "recommendationsAllowAnyStrategy":true,
        "recommendationsRestriction":null,
        "fromName":"Forgot Password xx",
        "recommendationsAllowRestrictions":true,
        "includeRecommendations":false,
        "id":"forgot_password_v1",
        "numberOfRecommendations":3,
        "recommendationsPermittedStrategies":[
        ]
    },
    "account_registration_v1":{
        "recommendationsSupported":true,
        "verificationStatus":1,
        "displayName":"New Account Email",
        "recommendationsStrategy":"bestSellers",
        "enabled":true,
        "fromEmail":"info@slc04lxz.us.oracle.com",
        "recommendationsAllowAnyStrategy":false,
        "recommendationsRestriction":null,
        "fromName":"New Account xx",
        "recommendationsAllowRestrictions":false,
        "includeRecommendations":true,
        "id":"account_registration_v1",
        "numberOfRecommendations":3,
        "recommendationsPermittedStrategies":[
            "topSellers"
        ]
    },
    "abandon_order_v1":{
        "recommendationsSupported":true,
        "verificationStatus":1,
        "displayName":"Abandon Order",
        "recommendationsStrategy":"blended",
        "enabled":true,
        "fromEmail":"info@slc04lxz.us.oracle.com",
        "recommendationsAllowAnyStrategy":true,
        "recommendationsRestriction":"unrestricted",
        "fromName":"Abandon Order xx",
        "recommendationsAllowRestrictions":true,
        "includeRecommendations":true,
        "id":"abandon_order_v1",
        "numberOfRecommendations":3,
        "recommendationsPermittedStrategies":[
        ]
    }
}

Default Response

The error response

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

{
  "forgotPassword": {
    "recommendationsSupported": false,
    "verificationStatus": 1,
    "displayName": "Forgot Password Email",
    "recommendationsStrategy": null,
    "enabled": true,
    "fromEmail": "info@slc04lxz.us.oracle.com",
    "recommendationsAllowAnyStrategy": true,
    "recommendationsRestriction": null,
    "fromName": "Forgot Password xx",
    "recommendationsAllowRestrictions": true,
    "includeRecommendations": false,
    "id": "forgot_password_v1",
    "numberOfRecommendations": 3,
    "recommendationsPermittedStrategies": []
  },
  "account_registration_v1": {
    "recommendationsSupported": true,
    "verificationStatus": 1,
    "displayName": "New Account Email",
    "recommendationsStrategy": "bestSellers",
    "enabled": true,
    "fromEmail": "info@slc04lxz.us.oracle.com",
    "recommendationsAllowAnyStrategy": false,
    "recommendationsRestriction": null,
    "fromName": "New Account xx",
    "recommendationsAllowRestrictions": false,
    "includeRecommendations": true,
    "id": "account_registration_v1",
    "numberOfRecommendations": 3,
    "recommendationsPermittedStrategies": ["topSellers"]
  },
  "abandon_order_v1": {
    "recommendationsSupported": true,
    "verificationStatus": 1,
    "displayName": "Abandon Order",
    "recommendationsStrategy": "blended",
    "enabled": true,
    "fromEmail": "info@slc04lxz.us.oracle.com",
    "recommendationsAllowAnyStrategy": true,
    "recommendationsRestriction": "unrestricted",
    "fromName": "Abandon Order xx",
    "recommendationsAllowRestrictions": true,
    "includeRecommendations": true,
    "id": "abandon_order_v1",
    "numberOfRecommendations": 3,
    "recommendationsPermittedStrategies": []
  }
}