Jump to

• Request
• Response

getEmailNotificationTypes

get

/ccadmin/v1/email/notificationTypes

Get Email Notification Types. Get the email notification types.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getEmailNotificationTypes_response

Type: object

Show Source

• items(optional): array items
  Email notification types

{
    "properties":{
        "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"
                    },
                    "verificationStatus":{
                        "description":"0 - Not applicable (BASIC/SMTP) 1 - Status not verified,2 - Status pending verification or 3 Status Verified",
                        "type":"integer"
                    },
                    "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 : items

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"
            },
            "verificationStatus":{
                "description":"0 - Not applicable (BASIC/SMTP) 1 - Status not verified,2 - Status pending verification or 3 Status Verified",
                "type":"integer"
            },
            "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 : 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
• verificationStatus(optional): integer
  0 - Not applicable (BASIC/SMTP) 1 - Status not verified,2 - Status pending verification or 3 Status Verified
• 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"
        },
        "verificationStatus":{
            "description":"0 - Not applicable (BASIC/SMTP) 1 - Status not verified,2 - Status pending verification or 3 Status Verified",
            "type":"integer"
        },
        "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)

{
    "forgotPassword":{
        "recommendationsSupported":false,
        "verificationStatus":1,
        "displayName":"Forgot Password Email",
        "recommendationsStrategy":null,
        "enabled":true,
        "fromEmail":"[e-mail]",
        "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":"[e-mail]",
        "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":"[e-mail]",
        "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

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