REST API for Oracle Commerce Cloud December 2017

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 Parameter

Root Schema : saveRemorsePeriod_request

Example


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

Properties

isRemorsePriod: Type: boolean

Required: true

Tells whether remorse period is enabled or not.
remorsePeriodHours: Type: string

Remorse period time in hours. Needed to specify when remorse period is enabled.
remorsePeriodMinutes: Type: string

Remorse period time in minutes(apart from the hours set). Needed to specify when remorse period is enabled.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : saveRemorsePeriod_response

Properties

isRemorsePriod: Type: boolean

Tells whether remorse period is set or not.
remorsePeriodHours: Type: integer

Remorse period time in hours.
remorsePeriodMinutes: Type: integer

Remorse period time in minutes(apart from the hours set).

Example 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

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:

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

Sample Response Payload returned by endpoint:

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