Jump to

• Request
• Response

saveRemorsePeriod

put

/ccadmin/v1/merchant/remorsePeriod

Save Remorse Period. Saves the remorse period and gets back the saved data.

Request

Supported Media Types

• application/json

Body ()

Root Schema : saveRemorsePeriod_request

Type: object

Show Source

• isRemorsePriod: boolean
  Tells whether remorse period is enabled or not.
• remorsePeriodHours(optional): string
  Remorse period time in hours. Needed to specify when remorse period is enabled.
• remorsePeriodMinutes(optional): string
  Remorse period time in minutes(apart from the hours set). Needed to specify when remorse period is enabled.

{
    "properties":{
        "remorsePeriodHours":{
            "description":"Remorse period time in hours. Needed to specify when remorse period is enabled.",
            "type":"string"
        },
        "isRemorsePriod":{
            "description":"Tells whether remorse period is enabled or not.",
            "type":"boolean"
        },
        "remorsePeriodMinutes":{
            "description":"Remorse period time in minutes(apart from the hours set). Needed to specify when remorse period is enabled.",
            "type":"string"
        }
    },
    "required":[
        "isRemorsePriod"
    ],
    "example":{
        "isRemorsePeriod":true,
        "remorsePeriodHours":"1",
        "remorsePeriodMinutes":"20"
    }
}

Example:

{
    "isRemorsePeriod":true,
    "remorsePeriodHours":"1",
    "remorsePeriodMinutes":"20"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : saveRemorsePeriod_response

Type: object

Show Source

• isRemorsePriod(optional): boolean
  Tells whether remorse period is set or not.
• remorsePeriodHours(optional): integer
  Remorse period time in hours.
• remorsePeriodMinutes(optional): integer
  Remorse period time in minutes(apart from the hours set).

{
    "properties":{
        "remorsePeriodHours":{
            "description":"Remorse period time in hours.",
            "type":"integer"
        },
        "isRemorsePriod":{
            "description":"Tells whether remorse period is set or not.",
            "type":"boolean"
        },
        "remorsePeriodMinutes":{
            "description":"Remorse period time in minutes(apart from the hours set).",
            "type":"integer"
        }
    }
}

Example Response (application/json)

{
    "isRemorsePeriod":true,
    "remorsePeriodHours":1,
    "remorsePeriodMinutes":20
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |96009|A problem occurred when saving the data.| |96005|Remorse period minutes must be numeric.| |96006|Remorse period minutes must be in range (0-59).| |96007|Invalid data for isRemorsePeriod. Value must be (true/false).| |96008|Unable to save remorse period data.| |96001|Remorse period hours is required.| |96002|Remorse period hours must be numeric.| |96003|Invalid data. Remorse period hours must be positive.| |96004|Remorse period minutes is required.|

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