Jump to

• Request
• Response

Retrieve email service data

get

/ccadmin/v1/email

Gets information on email types and email service configuration.

The information returned on email types includes site-specific settings, such as whether the email type is enabled and the from address and name to be used when composing emails.

The email service information returned includes things like the service type, the host and port for the SMTP service, and authentication settings.

This endpoint relies on the site context being specified via the X-CCSite request header or the occsite query parameter. If the site is omitted, the settings returned will be for the default site.

If the request is successful, the response body will be a JSON object containing two JSON objects: an 'emailNotificationTypes' object containing information on the available email types and their site-specific settings, and an 'emailServiceProperties' endpoint containing the email service settings.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returned when the operation succeeds.

Body ()

Root Schema : getEmailServiceData_response

Type: object

Show Source

• emailNotificationTypes(optional): array emailNotificationTypes
  Email Notification Types
• emailServiceProperties(optional): object emailServiceProperties
  Email service properties

{
    "properties":{
        "emailServiceProperties":{
            "description":"Email service properties",
            "type":"object",
            "properties":{
                "emailSMTPPort":{
                    "description":"Port to use to communicate with the SMTP host.",
                    "type":"string"
                },
                "emailSMTPHost":{
                    "description":"The SMTP host.",
                    "type":"string"
                },
                "emailServiceType":{
                    "description":"Must be DEFAULT or SMTP.",
                    "type":"string"
                },
                "emailSMTPPassword":{
                    "description":"User password for the SMTP server.",
                    "type":"string"
                },
                "emailSMTPAuthMethod":{
                    "description":"The SMTP Authorisation method - either SSL or TLS.",
                    "type":"string"
                },
                "emailSMTPUsername":{
                    "description":"User login for the SMTP server.",
                    "type":"string"
                }
            },
            "required":[
                "emailServiceType"
            ]
        },
        "emailNotificationTypes":{
            "description":"Email Notification Types",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "recommendationsSupported":{
                        "description":"true - product recommendations are supported, false - product recommendations are not supported",
                        "type":"boolean"
                    },
                    "displayName":{
                        "description":"email notification display name",
                        "type":"string"
                    },
                    "description":{
                        "description":"email notification description - usually null",
                        "type":"string"
                    },
                    "recommendationsStrategy":{
                        "description":"The recommendations strategy",
                        "type":"string"
                    },
                    "version":{
                        "description":"email notification version - usually 1",
                        "type":"integer"
                    },
                    "enabled":{
                        "description":"true - this notification is enabled and an email will be sent out, false - disable no email sent when triggered",
                        "type":"boolean"
                    },
                    "fromEmail":{
                        "description":"from email address",
                        "type":"string"
                    },
                    "recommendationsAllowAnyStrategy":{
                        "description":"true - any recommendations strategy (e.g. Blended, Top Sellers, Bought Together, Browsed Together) can be used, false - only specific recommendation strategies are permitted",
                        "type":"boolean"
                    },
                    "recommendationsRestriction":{
                        "description":"The recommendations restriction",
                        "type":"string"
                    },
                    "fromName":{
                        "description":"from name",
                        "type":"string"
                    },
                    "recommendationsAllowRestrictions":{
                        "description":"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",
                        "type":"boolean"
                    },
                    "includeRecommendations":{
                        "description":"true - product recommendations will be included in the email, false - product recommendations will not be included in the email",
                        "type":"boolean"
                    },
                    "id":{
                        "description":"key",
                        "type":"string"
                    },
                    "numberOfRecommendations":{
                        "description":"Number of product recommendations to include in email",
                        "type":"integer"
                    },
                    "recommendationsPermittedStrategies":{
                        "description":"Array of recommendation strategy keys permitted for this notification type",
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : emailNotificationTypes

Type: array

Email Notification Types

Show Source

• Array of: object items

{
    "description":"Email Notification Types",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "recommendationsSupported":{
                "description":"true - product recommendations are supported, false - product recommendations are not supported",
                "type":"boolean"
            },
            "displayName":{
                "description":"email notification display name",
                "type":"string"
            },
            "description":{
                "description":"email notification description - usually null",
                "type":"string"
            },
            "recommendationsStrategy":{
                "description":"The recommendations strategy",
                "type":"string"
            },
            "version":{
                "description":"email notification version - usually 1",
                "type":"integer"
            },
            "enabled":{
                "description":"true - this notification is enabled and an email will be sent out, false - disable no email sent when triggered",
                "type":"boolean"
            },
            "fromEmail":{
                "description":"from email address",
                "type":"string"
            },
            "recommendationsAllowAnyStrategy":{
                "description":"true - any recommendations strategy (e.g. Blended, Top Sellers, Bought Together, Browsed Together) can be used, false - only specific recommendation strategies are permitted",
                "type":"boolean"
            },
            "recommendationsRestriction":{
                "description":"The recommendations restriction",
                "type":"string"
            },
            "fromName":{
                "description":"from name",
                "type":"string"
            },
            "recommendationsAllowRestrictions":{
                "description":"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",
                "type":"boolean"
            },
            "includeRecommendations":{
                "description":"true - product recommendations will be included in the email, false - product recommendations will not be included in the email",
                "type":"boolean"
            },
            "id":{
                "description":"key",
                "type":"string"
            },
            "numberOfRecommendations":{
                "description":"Number of product recommendations to include in email",
                "type":"integer"
            },
            "recommendationsPermittedStrategies":{
                "description":"Array of recommendation strategy keys permitted for this notification type",
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : emailServiceProperties

Type: object

Email service properties

Show Source

• emailServiceType: string
  Must be DEFAULT or SMTP.
• emailSMTPAuthMethod(optional): string
  The SMTP Authorisation method - either SSL or TLS.
• emailSMTPHost(optional): string
  The SMTP host.
• emailSMTPPassword(optional): string
  User password for the SMTP server.
• emailSMTPPort(optional): string
  Port to use to communicate with the SMTP host.
• emailSMTPUsername(optional): string
  User login for the SMTP server.

{
    "description":"Email service properties",
    "type":"object",
    "properties":{
        "emailSMTPPort":{
            "description":"Port to use to communicate with the SMTP host.",
            "type":"string"
        },
        "emailSMTPHost":{
            "description":"The SMTP host.",
            "type":"string"
        },
        "emailServiceType":{
            "description":"Must be DEFAULT or SMTP.",
            "type":"string"
        },
        "emailSMTPPassword":{
            "description":"User password for the SMTP server.",
            "type":"string"
        },
        "emailSMTPAuthMethod":{
            "description":"The SMTP Authorisation method - either SSL or TLS.",
            "type":"string"
        },
        "emailSMTPUsername":{
            "description":"User login for the SMTP server.",
            "type":"string"
        }
    },
    "required":[
        "emailServiceType"
    ]
}

Nested Schema : items

Type: object

Show Source

• description(optional): string
  email notification description - usually null
• displayName(optional): string
  email notification display name
• enabled(optional): boolean
  true - this notification is enabled and an email will be sent out, false - disable no email sent when triggered
• fromEmail(optional): string
  from email address
• fromName(optional): string
  from name
• id(optional): string
  key
• includeRecommendations(optional): boolean
  true - product recommendations will be included in the email, false - product recommendations will not be included in the email
• numberOfRecommendations(optional): integer
  Number of product recommendations to include in email
• recommendationsAllowAnyStrategy(optional): 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(optional): 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(optional): array recommendationsPermittedStrategies
  Array of recommendation strategy keys permitted for this notification type
• recommendationsRestriction(optional): string
  The recommendations restriction
• recommendationsStrategy(optional): string
  The recommendations strategy
• recommendationsSupported(optional): boolean
  true - product recommendations are supported, false - product recommendations are not supported
• version(optional): integer
  email notification version - usually 1

{
    "type":"object",
    "properties":{
        "recommendationsSupported":{
            "description":"true - product recommendations are supported, false - product recommendations are not supported",
            "type":"boolean"
        },
        "displayName":{
            "description":"email notification display name",
            "type":"string"
        },
        "description":{
            "description":"email notification description - usually null",
            "type":"string"
        },
        "recommendationsStrategy":{
            "description":"The recommendations strategy",
            "type":"string"
        },
        "version":{
            "description":"email notification version - usually 1",
            "type":"integer"
        },
        "enabled":{
            "description":"true - this notification is enabled and an email will be sent out, false - disable no email sent when triggered",
            "type":"boolean"
        },
        "fromEmail":{
            "description":"from email address",
            "type":"string"
        },
        "recommendationsAllowAnyStrategy":{
            "description":"true - any recommendations strategy (e.g. Blended, Top Sellers, Bought Together, Browsed Together) can be used, false - only specific recommendation strategies are permitted",
            "type":"boolean"
        },
        "recommendationsRestriction":{
            "description":"The recommendations restriction",
            "type":"string"
        },
        "fromName":{
            "description":"from name",
            "type":"string"
        },
        "recommendationsAllowRestrictions":{
            "description":"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",
            "type":"boolean"
        },
        "includeRecommendations":{
            "description":"true - product recommendations will be included in the email, false - product recommendations will not be included in the email",
            "type":"boolean"
        },
        "id":{
            "description":"key",
            "type":"string"
        },
        "numberOfRecommendations":{
            "description":"Number of product recommendations to include in email",
            "type":"integer"
        },
        "recommendationsPermittedStrategies":{
            "description":"Array of recommendation strategy keys permitted for this notification type",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : recommendationsPermittedStrategies

Type: array

Array of recommendation strategy keys permitted for this notification type

Show Source

• Array of: string

{
    "description":"Array of recommendation strategy keys permitted for this notification type",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Example Response (application/json)

{
    "emailServiceProperties":{
        "emailServiceType":"DEFAULT"
    },
    "links":[
        {
            "rel":"self",
            "href":"/email"
        }
    ],
    "emailNotificationTypes":{
        "ccadmin_user_password_reset_v1":{
            "recommendationsSupported":false,
            "displayName":"Oracle Commerce Cloud Admin Password Reset",
            "description":null,
            "recommendationsStrategy":null,
            "version":1,
            "enabled":false,
            "fromEmail":null,
            "recommendationsAllowAnyStrategy":true,
            "recommendationsRestriction":null,
            "fromName":null,
            "recommendationsAllowRestrictions":true,
            "includeRecommendations":false,
            "id":"ccadmin_user_password_reset_v1",
            "recommendationsPermittedStrategies":[
            ],
            "numberOfRecommendations":12
        },
        "placed_order_v1":{
            "recommendationsSupported":false,
            "displayName":"Order Placed",
            "description":null,
            "recommendationsStrategy":null,
            "version":1,
            "enabled":false,
            "fromEmail":null,
            "recommendationsAllowAnyStrategy":true,
            "recommendationsRestriction":null,
            "fromName":null,
            "recommendationsAllowRestrictions":true,
            "includeRecommendations":false,
            "id":"placed_order_v1",
            "recommendationsPermittedStrategies":[
            ],
            "numberOfRecommendations":12
        }
    }
}

Default Response

The following internal error codes are thrown by this API when the request fails in Commerce:

Error Code	Description	Description	Possible Fix
950001	Unable to retrieve email service data.
950044	Error retrieving the Email Notification Types

The error response:

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top