Jump to

• Request
• Response

appeasementSubmit

post

/ccadmin/v1/webhook/appeasementSubmit

The details of the appeasement submitted in Oracle CX Commerce

Request

Supported Media Types

• application/json

Body ()

Root Schema : appeasementSubmit_request

Type: object

Show Source

• appeasement(optional): object appeasement
  Details of an appeasement

{
    "properties":{
        "appeasement":{
            "$ref":"#/definitions/appeasement"
        }
    },
    "example":{
        "appeasement":{
            "reason":{
                "readableDescription":"Item Arrived Damaged",
                "id":"itemArrivedDamaged"
            },
            "agentId":"service",
            "notes":"Customer complained that the order has arrived damaged, and asked for a refund of shipping amount. Providing 15 USD.",
            "orderId":"o10068",
            "damagedLineItemId":"ci123547",
            "lastModifiedDate":"2020-04-05T15:52:22.622Z",
            "appeasementRefunds":[
                {
                    "paymentGroupId":"p13343",
                    "refundType":"externalRefund",
                    "amount":5,
                    "customerPreferredGiftCardId":null,
                    "id":"3200006",
                    "state":"INCOMPLETE",
                    "currencyCode":"USD"
                },
                {
                    "paymentGroupId":"pg80414",
                    "refundType":"tokenizedCreditCard",
                    "amount":2,
                    "id":"3200006",
                    "state":"INCOMPLETE",
                    "currencyCode":"USD"
                }
            ],
            "type":{
                "displayName":"Order",
                "description":"Appeasement to be applied on a given order",
                "id":"order"
            },
            "creationDate":"2020-04-05T15:52:22.622Z",
            "submittedDate":"2020-04-05T15:52:22.622Z",
            "profileId":"se-570031",
            "links":[
                {
                    "rel":"self",
                    "href":"http://localhost:9080/ccagentui/v1/appeasements/submit"
                }
            ],
            "state":"SUBMITTED",
            "id":"app370003",
            "originOfAppeasement":"agent"
        }
    }
}

Example:

{
    "appeasement":{
        "reason":{
            "readableDescription":"Item Arrived Damaged",
            "id":"itemArrivedDamaged"
        },
        "agentId":"service",
        "notes":"Customer complained that the order has arrived damaged, and asked for a refund of shipping amount. Providing 15 USD.",
        "orderId":"o10068",
        "damagedLineItemId":"ci123547",
        "lastModifiedDate":"2020-04-05T15:52:22.622Z",
        "appeasementRefunds":[
            {
                "paymentGroupId":"p13343",
                "refundType":"externalRefund",
                "amount":5,
                "customerPreferredGiftCardId":null,
                "id":"3200006",
                "state":"INCOMPLETE",
                "currencyCode":"USD"
            },
            {
                "paymentGroupId":"pg80414",
                "refundType":"tokenizedCreditCard",
                "amount":2,
                "id":"3200006",
                "state":"INCOMPLETE",
                "currencyCode":"USD"
            }
        ],
        "type":{
            "displayName":"Order",
            "description":"Appeasement to be applied on a given order",
            "id":"order"
        },
        "creationDate":"2020-04-05T15:52:22.622Z",
        "submittedDate":"2020-04-05T15:52:22.622Z",
        "profileId":"se-570031",
        "links":[
            {
                "rel":"self",
                "href":"http://localhost:9080/ccagentui/v1/appeasements/submit"
            }
        ],
        "state":"SUBMITTED",
        "id":"app370003",
        "originOfAppeasement":"agent"
    }
}

Nested Schema : appeasement

Type: object

Details of an appeasement

Show Source

• agentId(optional): string
  Id of the agent who created the appeasement.
• appeasementRefunds(optional): object appeasementRefunds
  Properties of the appeasemen refund.
• 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): object reason
  Reason used for the appeasement. Detailed information
• 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): object type
  Type of appeasement, among the configured appeasement type in the system.

{
    "description":"Details of an appeasement",
    "type":"object",
    "properties":{
        "reason":{
            "description":"Reason used for the appeasement. Detailed information",
            "type":"object",
            "properties":{
                "readableDescription":{
                    "description":"Readable description of the appeasemen reason",
                    "type":"string"
                },
                "id":{
                    "description":"Id of the Appeasement reason",
                    "type":"string"
                }
            }
        },
        "agentId":{
            "description":"Id of the agent who created the appeasement.",
            "type":"string"
        },
        "notes":{
            "description":"Notes to describe the appeasement.",
            "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":"Properties of the appeasemen refund.",
            "type":"object",
            "properties":{
                "paymentGroupId":{
                    "description":"Associated Order payment group id.",
                    "type":"number"
                },
                "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":"object",
            "properties":{
                "displayName":{
                    "description":"Display name of the appeasemen reason",
                    "type":"string"
                },
                "description":{
                    "description":"Readable description of the appeasemen reason",
                    "type":"string"
                },
                "id":{
                    "description":"Id of the Appeasement reason",
                    "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"
        }
    }
}

Nested Schema : appeasementRefunds

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): number
  Associated Order payment group id.
• 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":"Associated Order payment group id.",
            "type":"number"
        },
        "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 : reason

Type: object

Reason used for the appeasement. Detailed information

Show Source

• id(optional): string
  Id of the Appeasement reason
• readableDescription(optional): string
  Readable description of the appeasemen reason

{
    "description":"Reason used for the appeasement. Detailed information",
    "type":"object",
    "properties":{
        "readableDescription":{
            "description":"Readable description of the appeasemen reason",
            "type":"string"
        },
        "id":{
            "description":"Id of the Appeasement reason",
            "type":"string"
        }
    }
}

Nested Schema : type

Type: object

Type of appeasement, among the configured appeasement type in the system.

Show Source

• description(optional): string
  Readable description of the appeasemen reason
• displayName(optional): string
  Display name of the appeasemen reason
• id(optional): string
  Id of the Appeasement reason

{
    "description":"Type of appeasement, among the configured appeasement type in the system.",
    "type":"object",
    "properties":{
        "displayName":{
            "description":"Display name of the appeasemen reason",
            "type":"string"
        },
        "description":{
            "description":"Readable description of the appeasemen reason",
            "type":"string"
        },
        "id":{
            "description":"Id of the Appeasement reason",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

No response is returned as this is an event webhook

Body ()

Root Schema : emptyResponse

Show Source

{
    "properties":{
    }
}

Back to Top