Jump to

• Request
• Response

initiateAppeasement

post

/ccagent/v1/appeasements/initiate

Initiates an Appeasement. This endpoint is mainly to validate the order and populate the possible refundTypes

Request

Supported Media Types

• application/json

Header Parameters

• X-CCAsset-Language(optional): string
  The asset language of the request. E.g., en,de,fr_CA.
• X-CCOrganization(optional): string
  The organization Id on which the appeasement is being submitted.
• X-CCSite(optional): string
  The site Id on which the appeasement is being submitted.

Body ()

Root Schema : initiateAppeasement_request

Type: object

Show Source

• orderId(optional): string
  Order Id for which the appeasement should be initiated

{
    "properties":{
        "orderId":{
            "description":"Order Id for which the appeasement should be initiated",
            "type":"string"
        }
    },
    "example":{
        "orderId":"o10068"
    }
}

Example:

{
    "orderId":"o10068"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : initiateAppeasement_response

Type: object

Show Source

• appeasementRefunds(optional): array appeasementRefunds
  Array of appeasement Refunds represents the list of payment instrument details that can be used for giving the appeasement.
• orderId(optional): string
  Id of the order in SUBMITTED or FULFILLED state, for which appeasement needs to be initiated.

{
    "properties":{
        "orderId":{
            "description":"Id of the order in SUBMITTED or FULFILLED state, for which appeasement needs to be initiated.",
            "type":"string"
        },
        "appeasementRefunds":{
            "description":"Array of appeasement Refunds represents the list of payment instrument details that can be used for giving the appeasement.",
            "type":"array",
            "items":{
                "description":"Properties of the appeasemen refund.",
                "type":"object",
                "properties":{
                    "paymentGroupId":{
                        "description":"Current state of the appeasement refund. It is among the predefined appeasement refund states.",
                        "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"
                    }
                }
            }
        }
    },
    "example":{
        "orderId":"o10068",
        "appeasementRefunds":[
            {
                "paymentGroupId":123556,
                "refundType":"creditCard",
                "amount":5,
                "id":"3200006",
                "state":"INCOMPLETE",
                "currencyCode":"USD"
            },
            {
                "paymentGroupId":123456,
                "refundType":"externalRefund",
                "amount":10,
                "customerPreferredGiftCardId":null,
                "id":"3200007",
                "state":"INCOMPLETE",
                "currencyCode":"USD"
            }
        ],
        "links":[
            {
                "rel":"self",
                "href":"http://localhost:9080/ccagentui/v1/appeasements/initiate"
            }
        ]
    }
}

Example:

{
    "orderId":"o10068",
    "appeasementRefunds":[
        {
            "paymentGroupId":123556,
            "refundType":"creditCard",
            "amount":5,
            "id":"3200006",
            "state":"INCOMPLETE",
            "currencyCode":"USD"
        },
        {
            "paymentGroupId":123456,
            "refundType":"externalRefund",
            "amount":10,
            "customerPreferredGiftCardId":null,
            "id":"3200007",
            "state":"INCOMPLETE",
            "currencyCode":"USD"
        }
    ],
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccagentui/v1/appeasements/initiate"
        }
    ]
}

Nested Schema : appeasementRefunds

Type: array

Array of appeasement Refunds represents the list of payment instrument details that can be used 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 can be used for giving the appeasement.",
    "type":"array",
    "items":{
        "description":"Properties of the appeasemen refund.",
        "type":"object",
        "properties":{
            "paymentGroupId":{
                "description":"Current state of the appeasement refund. It is among the predefined appeasement refund states.",
                "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 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
  Current state of the appeasement refund. It is among the predefined appeasement refund states.
• 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":"Current state of the appeasement refund. It is among the predefined appeasement refund states.",
            "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"
        }
    }
}

Default Response

The error response. The following are the error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |900000|When an internal error occurs| |13001|When the input is invalid| |900015|When an internal error occurs with the appeasementValidation webhook| |900016|When the appeasement is invalid according to the appeasementValidation webhook| |900017|When the invalid refundType is passed for an appeasement refund| |900001|If an internal error occurs with the repository| |900002|When the given appeasement Id is invalid or not found| |30014|SiteId passed in x-ccsite header is invalid or the site was deleted| |28107|Order is invalid|

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