REST API for Oracle Commerce Cloud

updateOrderFailureEmailSettings

put

/ccadmin/v1/merchant/orderFailureEmailSettings

Update the list of recipient email addresses for order failure notification

Request

Supported Media Types

application/json

Root Schema : updateOrderFailureEmailSettings_request

Type: object

Show Source

recipientEmailAddresses(required): array recipientEmailAddresses

List of recipient email addresses configured to receive order failure notification

{
    "properties":{
        "recipientEmailAddresses":{
            "description":"List of recipient email addresses configured to receive order failure notification",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "recipientEmailAddresses"
    ],
    "example":{
        "recipientEmailAddresses":[
            "Test@oracle.com",
            "Test2@oracle.com"
        ]
    }
}

Example:

{
    "recipientEmailAddresses":[
        "Test@oracle.com",
        "Test2@oracle.com"
    ]
}

Nested Schema : recipientEmailAddresses

Type: array

List of recipient email addresses configured to receive order failure notification

Show Source

Array of: string

{
    "description":"List of recipient email addresses configured to receive order failure notification",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Root Schema : getOrderFailureEmailSettings_response

Type: object

Show Source

recipientEmailAddresses: array recipientEmailAddresses

List of recipient email addresses configured to receive order failure notification

{
    "properties":{
        "recipientEmailAddresses":{
            "description":"List of recipient email addresses configured to receive order failure notification",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "example":{
        "recipientEmailAddresses":[
            "Test@oracle.com",
            "Test2@oracle.com"
        ]
    }
}

Example:

{
    "recipientEmailAddresses":[
        "Test@oracle.com",
        "Test2@oracle.com"
    ]
}

Nested Schema : recipientEmailAddresses

Type: array

List of recipient email addresses configured to receive order failure notification

Show Source

Array of: string

{
    "description":"List of recipient email addresses configured to receive order failure notification",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Default Response

The error response.

Root Schema : errorModel

Type: object

Show Source

devMessage: string

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

The numerical code identifying the error
errors: array errors

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

The localized message describing the error
moreInfo: string

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

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

The HTTP status code
type: 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: string

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

The numerical code identifying the error
message: string

The localized message describing the error
moreInfo: string

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

An optional machine readable description of where the error occurred
status: 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"
        }
    }
}