Jump to

• Request
• Response

createAppeasement

post

/ccadmin/v1/appeasements

Create Appeasement. Creates a new appeasement.

Request

Supported Media Types

• application/json

Body ()

Root Schema : createAppeasement_request

Type: object

Show Source

• agentId(optional): string
  Id of the agent who is creating appeasement. It is an optional property.
• appeasementRefunds(optional): array appeasementRefunds
  Array of appeasement Refunds represents the list of payment instrument details that we want to use for giving the appeasement.
• comments(optional): array comments
  Array of comments given on an appeasement.
• creationDate(optional): string
  Date and timestamp when the appeseasement is created.
• id(optional): string
  Appeasement ID of the appeasement to be created. By default, a system generated appeasement id will be considered, if not provided explicitly.
• notes(optional): string
  Notes to describe the appeasement.
• orderId(optional): string
  Id of the order, to which appeasement is associated. OrderId is required only in case of certain appeaesement types which are configured to mandate order as required.
• originOfAppeasement(optional): string
  Origin of appeasement signifies the channel of appeasement creation. By default, it is "external".
• profileId(optional): string
  Id of the user, to whom appeasement is given. It can be any valid string.
• reason: string
  Reason to create appeasement, among the configured appeasement reason in the system.
• state(optional): string
  Current state of the appeasement. It is among the predefined appeasement states. By default, it is "INCOMPLETE".
• type: string
  Type of appeasement, among the configured appeasement type in the system.

{
    "required":[
        "type",
        "reason"
    ],
    "properties":{
        "reason":{
            "description":"Reason to create appeasement, among the configured appeasement reason in the system.",
            "type":"string"
        },
        "agentId":{
            "description":"Id of the agent who is creating appeasement. It is an optional property.",
            "type":"string"
        },
        "notes":{
            "description":"Notes to describe the appeasement.",
            "type":"string"
        },
        "comments":{
            "description":"Array of comments given on an appeasement.",
            "type":"array",
            "items":{
                "description":"Properties of the comments",
                "type":"object",
                "required":[
                    "comment"
                ],
                "properties":{
                    "agentId":{
                        "description":"Agent who saved the comment.",
                        "type":"string"
                    },
                    "comment":{
                        "description":"Comment text.",
                        "type":"string"
                    },
                    "creationDate":{
                        "description":"Date and timestamp of the comment. If creation date is not provided in the input, system date will be considered by default.",
                        "type":"string"
                    }
                }
            }
        },
        "orderId":{
            "description":"Id of the order, to which appeasement is associated. OrderId is required only in case of certain appeaesement types which are configured to mandate order as required.",
            "type":"string"
        },
        "appeasementRefunds":{
            "description":"Array of appeasement Refunds represents the list of payment instrument details that we want to use for giving the appeasement.",
            "type":"array",
            "items":{
                "description":"Properties of the appeasement refund.",
                "type":"object",
                "required":[
                    "refundType"
                ],
                "properties":{
                    "paymentGroupId":{
                        "description":"Payment group id associated to order, to which appeasement is to be issued. It is a required property for out-of-the-box refund type.",
                        "type":"string"
                    },
                    "refundType":{
                        "description":"Type of appeasement refund, among the predefined appeasement refund types.",
                        "type":"string"
                    },
                    "amount":{
                        "description":"Appeasement refund amount to be given to the customer.",
                        "type":"number"
                    },
                    "id":{
                        "description":"Id of the Appeasement refund to be created. By default, a system generated id will be considered, if not provided explicitly.",
                        "type":"string"
                    },
                    "state":{
                        "description":"Current state of the appeasement refund. It is among the predefined appeasement refund states. By default, it is \"INCOMPLETE\".",
                        "type":"string"
                    },
                    "currencyCode":{
                        "description":"Currency code for the appeasement refund amount.",
                        "type":"string"
                    }
                }
            }
        },
        "profileId":{
            "description":"Id of the user, to whom appeasement is given. It can be any valid string.",
            "type":"string"
        },
        "id":{
            "description":"Appeasement ID of the appeasement to be created. By default, a system generated appeasement id will be considered, if not provided explicitly.",
            "type":"string"
        },
        "state":{
            "description":"Current state of the appeasement. It is among the predefined appeasement states. By default, it is \"INCOMPLETE\".",
            "type":"string"
        },
        "originOfAppeasement":{
            "description":"Origin of appeasement signifies the channel of appeasement creation. By default, it is \"external\".",
            "type":"string"
        },
        "type":{
            "description":"Type of appeasement, among the configured appeasement type in the system.",
            "type":"string"
        },
        "creationDate":{
            "description":"Date and timestamp when the appeseasement is created.",
            "type":"string"
        }
    },
    "example":{
        "reason":"incorrectItem",
        "agentId":"service",
        "notes":"Providing an appeasement of 20 USD which is 20% of the Order Total, according to the appeasement policy.",
        "comments":[
            {
                "agentId":"AgentBob",
                "comment":"Appeasement to be settled on priority. Valued customer.",
                "creationDate":"2020-03-20T04:56:13.935Z"
            }
        ],
        "orderId":"o1234",
        "appeasementRefunds":[
            {
                "paymentGroupId":"pg1001",
                "refundType":"externalRefund",
                "amount":20,
                "id":"ar1234",
                "state":"COMPLETE",
                "currencyCode":"USD"
            }
        ],
        "profileId":"se-570031",
        "id":"app1234",
        "state":"SUBMITTED",
        "type":"order"
    }
}

Example:

{
    "reason":"incorrectItem",
    "agentId":"service",
    "notes":"Providing an appeasement of 20 USD which is 20% of the Order Total, according to the appeasement policy.",
    "comments":[
        {
            "agentId":"AgentBob",
            "comment":"Appeasement to be settled on priority. Valued customer.",
            "creationDate":"2020-03-20T04:56:13.935Z"
        }
    ],
    "orderId":"o1234",
    "appeasementRefunds":[
        {
            "paymentGroupId":"pg1001",
            "refundType":"externalRefund",
            "amount":20,
            "id":"ar1234",
            "state":"COMPLETE",
            "currencyCode":"USD"
        }
    ],
    "profileId":"se-570031",
    "id":"app1234",
    "state":"SUBMITTED",
    "type":"order"
}

Nested Schema : appeasementRefunds

Type: array

Array of appeasement Refunds represents the list of payment instrument details that we want to use for giving the appeasement.

Show Source

• Array of: object items
  Properties of the appeasement refund.

{
    "description":"Array of appeasement Refunds represents the list of payment instrument details that we want to use for giving the appeasement.",
    "type":"array",
    "items":{
        "description":"Properties of the appeasement refund.",
        "type":"object",
        "required":[
            "refundType"
        ],
        "properties":{
            "paymentGroupId":{
                "description":"Payment group id associated to order, to which appeasement is to be issued. It is a required property for out-of-the-box refund type.",
                "type":"string"
            },
            "refundType":{
                "description":"Type of appeasement refund, among the predefined appeasement refund types.",
                "type":"string"
            },
            "amount":{
                "description":"Appeasement refund amount to be given to the customer.",
                "type":"number"
            },
            "id":{
                "description":"Id of the Appeasement refund to be created. By default, a system generated id will be considered, if not provided explicitly.",
                "type":"string"
            },
            "state":{
                "description":"Current state of the appeasement refund. It is among the predefined appeasement refund states. By default, it is \"INCOMPLETE\".",
                "type":"string"
            },
            "currencyCode":{
                "description":"Currency code for the appeasement refund amount.",
                "type":"string"
            }
        }
    }
}

Nested Schema : comments

Type: array

Array of comments given on an appeasement.

Show Source

• Array of: object items
  Properties of the comments

{
    "description":"Array of comments given on an appeasement.",
    "type":"array",
    "items":{
        "description":"Properties of the comments",
        "type":"object",
        "required":[
            "comment"
        ],
        "properties":{
            "agentId":{
                "description":"Agent who saved the comment.",
                "type":"string"
            },
            "comment":{
                "description":"Comment text.",
                "type":"string"
            },
            "creationDate":{
                "description":"Date and timestamp of the comment. If creation date is not provided in the input, system date will be considered by default.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Properties of the appeasement refund.

Show Source

• amount(optional): number
  Appeasement refund amount to be given to the customer.
• currencyCode(optional): string
  Currency code for the appeasement refund amount.
• id(optional): string
  Id of the Appeasement refund to be created. By default, a system generated id will be considered, if not provided explicitly.
• paymentGroupId(optional): string
  Payment group id associated to order, to which appeasement is to be issued. It is a required property for out-of-the-box refund type.
• refundType: string
  Type of appeasement refund, among the predefined appeasement refund types.
• state(optional): string
  Current state of the appeasement refund. It is among the predefined appeasement refund states. By default, it is "INCOMPLETE".

{
    "description":"Properties of the appeasement refund.",
    "type":"object",
    "required":[
        "refundType"
    ],
    "properties":{
        "paymentGroupId":{
            "description":"Payment group id associated to order, to which appeasement is to be issued. It is a required property for out-of-the-box refund type.",
            "type":"string"
        },
        "refundType":{
            "description":"Type of appeasement refund, among the predefined appeasement refund types.",
            "type":"string"
        },
        "amount":{
            "description":"Appeasement refund amount to be given to the customer.",
            "type":"number"
        },
        "id":{
            "description":"Id of the Appeasement refund to be created. By default, a system generated id will be considered, if not provided explicitly.",
            "type":"string"
        },
        "state":{
            "description":"Current state of the appeasement refund. It is among the predefined appeasement refund states. By default, it is \"INCOMPLETE\".",
            "type":"string"
        },
        "currencyCode":{
            "description":"Currency code for the appeasement refund amount.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Properties of the comments

Show Source

• agentId(optional): string
  Agent who saved the comment.
• comment: string
  Comment text.
• creationDate(optional): string
  Date and timestamp of the comment. If creation date is not provided in the input, system date will be considered by default.

{
    "description":"Properties of the comments",
    "type":"object",
    "required":[
        "comment"
    ],
    "properties":{
        "agentId":{
            "description":"Agent who saved the comment.",
            "type":"string"
        },
        "comment":{
            "description":"Comment text.",
            "type":"string"
        },
        "creationDate":{
            "description":"Date and timestamp of the comment. If creation date is not provided in the input, system date will be considered by default.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : createAppeasement_response

Type: object

Show Source

• agentId(optional): string
  Id of the agent who created the appeasement.
• appeasementRefunds(optional): array appeasementRefunds
  Array of appeasement Refunds represents the list of payment instrument details that we want to use for giving the appeasement.
• comments(optional): array comments
  Array of comments given on an appeasement.
• creationDate(optional): string
  Date and timestamp when the appeseasement is created.
• id(optional): string
  Id of the appeasement.
• lastModifiedDate(optional): string
  Date and timestamp when the appeseasement is modified recently.
• notes(optional): string
  Notes to describe the appeasement.
• orderId(optional): string
  Id of the order, to which appeasement is given.
• originOfAppeasement(optional): string
  Origin of appeasement signifies the channel of appeasement created.
• profileId(optional): string
  Id of the user, to whom appeasement is given.
• reason(optional): string
  Reason for the appeasement, among the configured appeasement reason in the system.
• state(optional): string
  Current state of the appeasement. It is among the predefined appeasement states.
• submittedDate(optional): string
  Date and timestamp when the appeseasement is submitted.
• type(optional): string
  Type of appeasement, among the configured appeasement type in the system.

{
    "properties":{
        "reason":{
            "description":"Reason for the appeasement, among the configured appeasement reason in the system.",
            "type":"string"
        },
        "agentId":{
            "description":"Id of the agent who created the appeasement.",
            "type":"string"
        },
        "notes":{
            "description":"Notes to describe the appeasement.",
            "type":"string"
        },
        "comments":{
            "description":"Array of comments given on an appeasement.",
            "type":"array",
            "items":{
                "description":"Properties of the comments",
                "type":"object",
                "properties":{
                    "agentId":{
                        "description":"Agent who saved the comment.",
                        "type":"string"
                    },
                    "comment":{
                        "description":"Comment text.",
                        "type":"string"
                    },
                    "id":{
                        "description":"Id of the comment associated to the appeasement.",
                        "type":"string"
                    },
                    "creationDate":{
                        "description":"Date and timestamp of the comment.",
                        "type":"string"
                    }
                }
            }
        },
        "orderId":{
            "description":"Id of the order, to which appeasement is given.",
            "type":"string"
        },
        "lastModifiedDate":{
            "description":"Date and timestamp when the appeseasement is modified recently.",
            "type":"string"
        },
        "appeasementRefunds":{
            "description":"Array of appeasement Refunds represents the list of payment instrument details that we want to use for giving the appeasement.",
            "type":"array",
            "items":{
                "description":"Properties of the appeasemen refund.",
                "type":"object",
                "properties":{
                    "paymentGroupId":{
                        "description":"Payment group id associated to order, to which appeasement is issued.",
                        "type":"string"
                    },
                    "refundType":{
                        "description":"Type of appeasement refund, among the predefined appeasement refund types.",
                        "type":"string"
                    },
                    "amount":{
                        "description":"Appeasement refund amount issued to the customer.",
                        "type":"number"
                    },
                    "id":{
                        "description":"Id of the Appeasement refund associated to an appeasement.",
                        "type":"string"
                    },
                    "state":{
                        "description":"Current state of the appeasement refund. It is among the predefined appeasement refund states.",
                        "type":"string"
                    },
                    "currencyCode":{
                        "description":"Currency code for the appeasement refund amount.",
                        "type":"string"
                    }
                }
            }
        },
        "type":{
            "description":"Type of appeasement, among the configured appeasement type in the system.",
            "type":"string"
        },
        "creationDate":{
            "description":"Date and timestamp when the appeseasement is created.",
            "type":"string"
        },
        "submittedDate":{
            "description":"Date and timestamp when the appeseasement is submitted.",
            "type":"string"
        },
        "profileId":{
            "description":"Id of the user, to whom appeasement is given.",
            "type":"string"
        },
        "id":{
            "description":"Id of the appeasement.",
            "type":"string"
        },
        "state":{
            "description":"Current state of the appeasement. It is among the predefined appeasement states.",
            "type":"string"
        },
        "originOfAppeasement":{
            "description":"Origin of appeasement signifies the channel of appeasement created.",
            "type":"string"
        }
    },
    "example":{
        "reason":"incorrectItem",
        "agentId":"service",
        "notes":"Providing an appeasement of 20 USD which is 20% of the Order Total, according to the appeasement policy.",
        "comments":[
            {
                "agentId":"AgentBob",
                "comment":"Appeasement to be settled on priority. Valued customer.",
                "id":100001,
                "creationDate":"2020-03-20T04:56:13.935Z"
            }
        ],
        "orderId":"o1234",
        "appeasementRefunds":[
            {
                "paymentGroupId":"pg1001",
                "refundType":"externalRefund",
                "amount":20,
                "id":"ar1234",
                "state":"COMPLETE",
                "currencyCode":"USD"
            }
        ],
        "lastModifiedDate":"2020-03-20T05:15:05.645Z",
        "type":"order",
        "creationDate":"2020-03-20T04:56:13.935Z",
        "submittedDate":"2020-04-20T04:56:13.935Z",
        "profileId":"se-570031",
        "id":"app1234",
        "state":"SUBMITTED",
        "originOfAppeasement":"external"
    }
}

Example:

{
    "reason":"incorrectItem",
    "agentId":"service",
    "notes":"Providing an appeasement of 20 USD which is 20% of the Order Total, according to the appeasement policy.",
    "comments":[
        {
            "agentId":"AgentBob",
            "comment":"Appeasement to be settled on priority. Valued customer.",
            "id":100001,
            "creationDate":"2020-03-20T04:56:13.935Z"
        }
    ],
    "orderId":"o1234",
    "appeasementRefunds":[
        {
            "paymentGroupId":"pg1001",
            "refundType":"externalRefund",
            "amount":20,
            "id":"ar1234",
            "state":"COMPLETE",
            "currencyCode":"USD"
        }
    ],
    "lastModifiedDate":"2020-03-20T05:15:05.645Z",
    "type":"order",
    "creationDate":"2020-03-20T04:56:13.935Z",
    "submittedDate":"2020-04-20T04:56:13.935Z",
    "profileId":"se-570031",
    "id":"app1234",
    "state":"SUBMITTED",
    "originOfAppeasement":"external"
}

Nested Schema : appeasementRefunds

Type: array

Array of appeasement Refunds represents the list of payment instrument details that we want to use for giving the appeasement.

Show Source

• Array of: object items
  Properties of the appeasemen refund.

{
    "description":"Array of appeasement Refunds represents the list of payment instrument details that we want to use for giving the appeasement.",
    "type":"array",
    "items":{
        "description":"Properties of the appeasemen refund.",
        "type":"object",
        "properties":{
            "paymentGroupId":{
                "description":"Payment group id associated to order, to which appeasement is issued.",
                "type":"string"
            },
            "refundType":{
                "description":"Type of appeasement refund, among the predefined appeasement refund types.",
                "type":"string"
            },
            "amount":{
                "description":"Appeasement refund amount issued to the customer.",
                "type":"number"
            },
            "id":{
                "description":"Id of the Appeasement refund associated to an appeasement.",
                "type":"string"
            },
            "state":{
                "description":"Current state of the appeasement refund. It is among the predefined appeasement refund states.",
                "type":"string"
            },
            "currencyCode":{
                "description":"Currency code for the appeasement refund amount.",
                "type":"string"
            }
        }
    }
}

Nested Schema : comments

Type: array

Array of comments given on an appeasement.

Show Source

• Array of: object items
  Properties of the comments

{
    "description":"Array of comments given on an appeasement.",
    "type":"array",
    "items":{
        "description":"Properties of the comments",
        "type":"object",
        "properties":{
            "agentId":{
                "description":"Agent who saved the comment.",
                "type":"string"
            },
            "comment":{
                "description":"Comment text.",
                "type":"string"
            },
            "id":{
                "description":"Id of the comment associated to the appeasement.",
                "type":"string"
            },
            "creationDate":{
                "description":"Date and timestamp of the comment.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Properties of the appeasemen refund.

Show Source

• amount(optional): number
  Appeasement refund amount issued to the customer.
• currencyCode(optional): string
  Currency code for the appeasement refund amount.
• id(optional): string
  Id of the Appeasement refund associated to an appeasement.
• paymentGroupId(optional): string
  Payment group id associated to order, to which appeasement is issued.
• refundType(optional): string
  Type of appeasement refund, among the predefined appeasement refund types.
• state(optional): string
  Current state of the appeasement refund. It is among the predefined appeasement refund states.

{
    "description":"Properties of the appeasemen refund.",
    "type":"object",
    "properties":{
        "paymentGroupId":{
            "description":"Payment group id associated to order, to which appeasement is issued.",
            "type":"string"
        },
        "refundType":{
            "description":"Type of appeasement refund, among the predefined appeasement refund types.",
            "type":"string"
        },
        "amount":{
            "description":"Appeasement refund amount issued to the customer.",
            "type":"number"
        },
        "id":{
            "description":"Id of the Appeasement refund associated to an appeasement.",
            "type":"string"
        },
        "state":{
            "description":"Current state of the appeasement refund. It is among the predefined appeasement refund states.",
            "type":"string"
        },
        "currencyCode":{
            "description":"Currency code for the appeasement refund amount.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Properties of the comments

Show Source

• agentId(optional): string
  Agent who saved the comment.
• comment(optional): string
  Comment text.
• creationDate(optional): string
  Date and timestamp of the comment.
• id(optional): string
  Id of the comment associated to the appeasement.

{
    "description":"Properties of the comments",
    "type":"object",
    "properties":{
        "agentId":{
            "description":"Agent who saved the comment.",
            "type":"string"
        },
        "comment":{
            "description":"Comment text.",
            "type":"string"
        },
        "id":{
            "description":"Id of the comment associated to the appeasement.",
            "type":"string"
        },
        "creationDate":{
            "description":"Date and timestamp of the comment.",
            "type":"string"
        }
    }
}

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| |------------------|------------------| |900001|An internal error occurred.| |900005|An internal error occured while processing the input request| |900009|An error for appeasement id duplication.| |13001|Input validation error.|

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