Jump to

• Request
• Response

getAppeasement

get

/ccagent/v1/appeasements/{id}

Get Appeasement. Gets a detailed appeasement information based on the appeasement ID provided.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  ID corresponding to the appeasement to be fetched.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getAppeasement_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 in SUBMITTED or FULFILLED state, to which appeasement is given.
• originOfAppeasement(optional): string
  Origin of appeasement signifies the channel of appeasement creation.
• profileId(optional): string
  Id of an registered user, to whom appeasement is given.
• reason(optional): object reason
  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.
• type(optional): object type
  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":"object",
            "properties":{
                "readableDescription":{
                    "description":"Description of the appeasement 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"
        },
        "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 in SUBMITTED or FULFILLED state, 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 appeasement refund.",
                "type":"object",
                "properties":{
                    "paymentGroupId":{
                        "description":"Payment group id of the refund type. Required for OOTB refunds.",
                        "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"
                    },
                    "type":{
                        "description":"Type of appeasement refund, among the predefined appeasement refund types.",
                        "type":"string"
                    },
                    "currencyCode":{
                        "description":"Curency code in which the amount should be refunded. Required when refund is not related to a payment group.",
                        "type":"string"
                    }
                }
            }
        },
        "type":{
            "description":"Type of appeasement, among the configured appeasement type in the system.",
            "type":"object",
            "properties":{
                "displayName":{
                    "description":"Name of the appeasement type.",
                    "type":"string"
                },
                "description":{
                    "description":"Description of the appeasement type.",
                    "type":"string"
                },
                "id":{
                    "description":"Id of the appeasement type.",
                    "type":"string"
                }
            }
        },
        "creationDate":{
            "description":"Date and timestamp when the appeseasement is created.",
            "type":"string"
        },
        "profileId":{
            "description":"Id of an registered 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 creation.",
            "type":"string"
        }
    },
    "example":{
        "reason":{
            "readableDescription":"Incorrect Item Received",
            "id":"incorrectItem"
        },
        "agentId":"service",
        "notes":"Providing an appeasement of 20 USD which is 20% of the Order Total, according to the appeasement policy.",
        "comments":[
            {
                "agentId":"service",
                "comment":"Appeasement to be settled on priority. Valued customer.",
                "id":100001,
                "creationDate":"2020-03-20T04:56:13.935Z"
            }
        ],
        "orderId":"o1234",
        "appeasementRefunds":[
            {
                "amount":20,
                "id":"ar1234",
                "state":"COMPLETE",
                "type":"externalRefund"
            }
        ],
        "lastModifiedDate":"2020-03-20T05:15:05.645Z",
        "type":{
            "displayName":"Order",
            "description":"Appeasement to be applied on a given order",
            "id":"order"
        },
        "creationDate":"2020-03-20T04:56:13.935Z",
        "profileId":"se-570031",
        "id":"app1234",
        "state":"SUBMITTED",
        "originOfAppeasement":"external"
    }
}

Example:

{
    "reason":{
        "readableDescription":"Incorrect Item Received",
        "id":"incorrectItem"
    },
    "agentId":"service",
    "notes":"Providing an appeasement of 20 USD which is 20% of the Order Total, according to the appeasement policy.",
    "comments":[
        {
            "agentId":"service",
            "comment":"Appeasement to be settled on priority. Valued customer.",
            "id":100001,
            "creationDate":"2020-03-20T04:56:13.935Z"
        }
    ],
    "orderId":"o1234",
    "appeasementRefunds":[
        {
            "amount":20,
            "id":"ar1234",
            "state":"COMPLETE",
            "type":"externalRefund"
        }
    ],
    "lastModifiedDate":"2020-03-20T05:15:05.645Z",
    "type":{
        "displayName":"Order",
        "description":"Appeasement to be applied on a given order",
        "id":"order"
    },
    "creationDate":"2020-03-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 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",
        "properties":{
            "paymentGroupId":{
                "description":"Payment group id of the refund type. Required for OOTB refunds.",
                "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"
            },
            "type":{
                "description":"Type of appeasement refund, among the predefined appeasement refund types.",
                "type":"string"
            },
            "currencyCode":{
                "description":"Curency code in which the amount should be refunded. Required when refund is not related to a payment group.",
                "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 : reason

Type: object

Reason for the appeasement, among the configured appeasement reason in the system.

Show Source

• id(optional): string
  Id of the appeasement reason.
• readableDescription(optional): string
  Description of the appeasement reason.

{
    "description":"Reason for the appeasement, among the configured appeasement reason in the system.",
    "type":"object",
    "properties":{
        "readableDescription":{
            "description":"Description of the appeasement 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
  Description of the appeasement type.
• displayName(optional): string
  Name of the appeasement type.
• id(optional): string
  Id of the appeasement type.

{
    "description":"Type of appeasement, among the configured appeasement type in the system.",
    "type":"object",
    "properties":{
        "displayName":{
            "description":"Name of the appeasement type.",
            "type":"string"
        },
        "description":{
            "description":"Description of the appeasement type.",
            "type":"string"
        },
        "id":{
            "description":"Id of the appeasement type.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Properties of the appeasement refund.

Show Source

• amount(optional): number
  Appeasement refund amount issued to the customer.
• currencyCode(optional): string
  Curency code in which the amount should be refunded. Required when refund is not related to a payment group.
• id(optional): string
  Id of the Appeasement refund associated to an appeasement.
• paymentGroupId(optional): string
  Payment group id of the refund type. Required for OOTB refunds.
• state(optional): string
  Current state of the appeasement refund. It is among the predefined appeasement refund states.
• type(optional): string
  Type of appeasement refund, among the predefined appeasement refund types.

{
    "description":"Properties of the appeasement refund.",
    "type":"object",
    "properties":{
        "paymentGroupId":{
            "description":"Payment group id of the refund type. Required for OOTB refunds.",
            "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"
        },
        "type":{
            "description":"Type of appeasement refund, among the predefined appeasement refund types.",
            "type":"string"
        },
        "currencyCode":{
            "description":"Curency code in which the amount should be refunded. Required when refund is not related to a payment group.",
            "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 while processing input request.| |900002|No Appeasement found with given appeasement id| |900004|An internal error occured.|

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