REST API for Oracle Commerce Cloud December 2017

setEmailServiceData

post

/ccadmin/v1/email

Set Email Service Data. Update the email service data.

Request

Supported Media Types

application/json

Body Parameter

Root Schema : setEmailServiceData_request

Example


{
    "emailServiceProperties":{
        "emailSMTPPort":"25",
        "emailSMTPHost":"127.0.0.1",
        "emailServiceType":"BASIC",
        "emailSMTPAuthMethod":"TLS",
        "emailSMTPPassword":"",
        "emailSMTPUsername":""
    },
    "emailNotificationTypes":[
        {
            "verificationStatus":0,
            "displayName":"Forgot Password Email",
            "recommendationsRestriction":null,
            "fromName":"Forgot Password",
            "includeRecommendations":false,
            "id":"forgot_password_v1",
            "numberOfRecommendations":3,
            "recommendationsStrategy":null,
            "enabled":true,
            "fromEmail":"info@slc04lxz.us.oracle.com"
        },
        {
            "verificationStatus":0,
            "displayName":"Abandon Order",
            "recommendationsRestriction":"unrestricted",
            "fromName":"Abandon Order xx",
            "includeRecommendations":true,
            "id":"abandon_order_v1",
            "numberOfRecommendations":3,
            "recommendationsStrategy":"blended",
            "enabled":true,
            "fromEmail":"info@slc04lxz.us.oracle.com"
        },
        {
            "verificationStatus":0,
            "displayName":"New Account Email",
            "recommendationsRestriction":null,
            "fromName":"New Account xx",
            "includeRecommendations":true,
            "id":"account_registration_v1",
            "numberOfRecommendations":3,
            "recommendationsStrategy":"bestSellers",
            "enabled":true,
            "fromEmail":"info@slc04lxz.us.oracle.com"
        }
    ]
}

Properties

emailNotificationTypes: Type: array emailNotificationTypes

Additional Properties Allowed:

Email Notification Types
emailServiceProperties: Type: object emailServiceProperties

Additional Properties Allowed:

Email Service Properties

Nested Schema : emailNotificationTypes

Type: array

Email Notification Types

Items

Type: object items

Additional Properties Allowed:

Nested Schema : emailServiceProperties

Type: object

Email Service Properties

Properties

emailServiceType: Type: string

Required: true

Must be BASIC, SMTP or CNS (Oracle Cloud Notification Service).
emailSMTPAuthMethod: Type: string

The SMTP Authorisation method - either SSL or TLS.
emailSMTPHost: Type: string

The SMTP host.
emailSMTPPassword: Type: string

User password for the SMTP server.
emailSMTPPort: Type: string

Port to use to communicate with the SMTP host.
emailSMTPUsername: Type: string

User login for the SMTP server.

Nested Schema : items

Type: object

Properties

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
recommendationsRestriction: Type: string

The recommendations restriction
recommendationsStrategy: Type: string

The recommendations strategy
verificationStatus: Type: integer

0 - Not applicable (for BASIC/SMTP service type), 1 - Status not verified,2 - Status pending verification or 3 Status Verified

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : setEmailServiceData_response

Properties

emailNotificationTypes: Type: array emailNotificationTypes

Additional Properties Allowed:

Email notification types
emailServiceProperties: Type: object emailServiceProperties

Additional Properties Allowed:

Email service properties

Nested Schema : emailNotificationTypes

Type: array

Email notification types

Items

Type: object items

Additional Properties Allowed:

Nested Schema : emailServiceProperties

Type: object

Email service properties

Properties

emailServiceType: Type: string

Required: true

Must be BASIC, SMTP or CNS (Oracle Cloud Notification Service).
emailSMTPAuthMethod: Type: string

The SMTP Authorisation method - either SSL or TLS.
emailSMTPHost: Type: string

The SMTP host.
emailSMTPPassword: Type: string

User password for the SMTP server.
emailSMTPPort: Type: string

Port to use to communicate with the SMTP host.
emailSMTPUsername: Type: string

User login for the SMTP server.

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


{
    "emailServiceProperties":{
        "emailSMTPPort":"25",
        "emailSMTPHost":"127.0.0.1",
        "emailServiceType":"BASIC",
        "emailSMTPAuthMethod":"TLS",
        "emailSMTPUsername":""
    },
    "emailNotificationTypes":{
        "abandoned_order_v1":{
            "recommendationsSupported":true,
            "verificationStatus":0,
            "displayName":"Abandon Order",
            "description":null,
            "recommendationsStrategy":"blended",
            "version":1,
            "enabled":true,
            "fromEmail":"info@slc04lxz.us.oracle.com",
            "recommendationsAllowAnyStrategy":true,
            "recommendationsRestriction":"unrestricted",
            "fromName":"Abandon Order xx",
            "recommendationsAllowRestrictions":true,
            "includeRecommendations":true,
            "id":"abandoned_order_v1",
            "numberOfRecommendations":3,
            "recommendationsPermittedStrategies":[
            ]
        },
        "forgot_password_v1":{
            "recommendationsSupported":false,
            "verificationStatus":0,
            "displayName":"Forgotten Password",
            "description":null,
            "recommendationsStrategy":null,
            "version":1,
            "enabled":true,
            "fromEmail":"info@slc04lxz.us.oracle.com",
            "recommendationsAllowAnyStrategy":true,
            "recommendationsRestriction":null,
            "fromName":"Forgot Password",
            "recommendationsAllowRestrictions":true,
            "includeRecommendations":false,
            "id":"forgot_password_v1",
            "numberOfRecommendations":12,
            "recommendationsPermittedStrategies":[
            ]
        },
        "account_registration_v1":{
            "recommendationsSupported":true,
            "verificationStatus":0,
            "displayName":"New Account",
            "description":null,
            "recommendationsStrategy":"topSellers",
            "version":1,
            "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":12,
            "recommendationsPermittedStrategies":[
                "topSellers"
            ]
        }
    }
}

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 Request:

{
  "emailServiceProperties": {
    "emailSMTPPort": "25",
    "emailSMTPHost": "127.0.0.1",
    "emailServiceType": "BASIC",
    "emailSMTPAuthMethod": "TLS",
    "emailSMTPPassword": "",
    "emailSMTPUsername": ""
  },
  "emailNotificationTypes": [
    {
      "verificationStatus": 0,
      "displayName": "Forgot Password Email",
      "recommendationsRestriction": null,
      "fromName": "Forgot Password",
      "includeRecommendations": false,
      "id": "forgot_password_v1",
      "numberOfRecommendations": 3,
      "recommendationsStrategy": null,
      "enabled": true,
      "fromEmail": "info@slc04lxz.us.oracle.com"
    },
    {
      "verificationStatus": 0,
      "displayName": "Abandon Order",
      "recommendationsRestriction": "unrestricted",
      "fromName": "Abandon Order xx",
      "includeRecommendations": true,
      "id": "abandon_order_v1",
      "numberOfRecommendations": 3,
      "recommendationsStrategy": "blended",
      "enabled": true,
      "fromEmail": "info@slc04lxz.us.oracle.com"
    },
    {
      "verificationStatus": 0,
      "displayName": "New Account Email",
      "recommendationsRestriction": null,
      "fromName": "New Account xx",
      "includeRecommendations": true,
      "id": "account_registration_v1",
      "numberOfRecommendations": 3,
      "recommendationsStrategy": "bestSellers",
      "enabled": true,
      "fromEmail": "info@slc04lxz.us.oracle.com"
    }
  ]
}

Sample Response Payload returned by endpoint:

{
  "emailServiceProperties": {
    "emailSMTPPort": "25",
    "emailSMTPHost": "127.0.0.1",
    "emailServiceType": "BASIC",
    "emailSMTPAuthMethod": "TLS",
    "emailSMTPUsername": ""
  },
  "emailNotificationTypes": {
    "abandoned_order_v1": {
      "recommendationsSupported": true,
      "verificationStatus": 0,
      "displayName": "Abandon Order",
      "description": null,
      "recommendationsStrategy": "blended",
      "version": 1,
      "enabled": true,
      "fromEmail": "info@slc04lxz.us.oracle.com",
      "recommendationsAllowAnyStrategy": true,
      "recommendationsRestriction": "unrestricted",
      "fromName": "Abandon Order xx",
      "recommendationsAllowRestrictions": true,
      "includeRecommendations": true,
      "id": "abandoned_order_v1",
      "numberOfRecommendations": 3,
      "recommendationsPermittedStrategies": []
    },
    "forgot_password_v1": {
      "recommendationsSupported": false,
      "verificationStatus": 0,
      "displayName": "Forgotten Password",
      "description": null,
      "recommendationsStrategy": null,
      "version": 1,
      "enabled": true,
      "fromEmail": "info@slc04lxz.us.oracle.com",
      "recommendationsAllowAnyStrategy": true,
      "recommendationsRestriction": null,
      "fromName": "Forgot Password",
      "recommendationsAllowRestrictions": true,
      "includeRecommendations": false,
      "id": "forgot_password_v1",
      "numberOfRecommendations": 12,
      "recommendationsPermittedStrategies": []
    },
    "account_registration_v1": {
      "recommendationsSupported": true,
      "verificationStatus": 0,
      "displayName": "New Account",
      "description": null,
      "recommendationsStrategy": "topSellers",
      "version": 1,
      "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": 12,
      "recommendationsPermittedStrategies": ["topSellers"]
    }
  }
}