Jump to

• Request
• Response

calculateRemainingRefund

post

/ccagent/v1/returnRequests/{id}/calculateRemainingRefund

Endpoint to return suggested refund amount remaining in the price list group's currency as well as alternate currency in cases where allowAlternateCurrency flag at site level is true. Note that, this endpoint is just for suggesting remaining refund amount which need to be adjusted in refund methods

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  The return request id.

Body ()

Root Schema : calculateRemainingRefund_request

Type: object

Show Source

• primaryCurrencyRefundAmount: number
  Sum of refund method amounts which point to payment groups where currency code = PLG's currency code
• secondaryCurrencyRefundAmount: number
  Sum of refund method amounts which point to payment groups where currency code = alternate currency code

{
    "properties":{
        "primaryCurrencyRefundAmount":{
            "description":"Sum of refund method amounts which point to payment groups where currency code = PLG's currency code",
            "type":"number"
        },
        "secondaryCurrencyRefundAmount":{
            "description":"Sum of refund method amounts which point to payment groups where currency code = alternate currency code",
            "type":"number"
        }
    },
    "required":[
        "primaryCurrencyRefundAmount",
        "secondaryCurrencyRefundAmount"
    ],
    "example":{
        "primaryCurrencyRefundAmount":0,
        "secondaryCurrencyRefundAmount":0
    }
}

Example:

{
    "primaryCurrencyRefundAmount":0,
    "secondaryCurrencyRefundAmount":0
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : calculateRemainingRefund_response

Type: object

Show Source

• minimumAmountInPrimaryCurrency(optional): number
  Minimum amount which should be included in refund method's where refund method currency code = order's priceListGroup currency code
• minimumAmountInSecondaryCurrency(optional): number
  Minimum amount which should be included in refund method's where refund method currency code = alternate currency code
• remainingRefundAmountInPrimaryCurrency(optional): number
  Remaining refund amount which can be adjusted/included in refund method's where refund method currency code = order's priceListGroup currency code
• remainingRefundAmountInSecondaryCurrency(optional): number
  Remaining refund amount which can be adjusted/included in refund method's where refund method currency code = alternate currency code
• totalRefundAmount(optional): number
  Total refund amount in order's priceListGroup currency

{
    "properties":{
        "remainingRefundAmountInPrimaryCurrency":{
            "description":"Remaining refund amount which can be adjusted/included in refund method's where refund method currency code = order's priceListGroup currency code",
            "type":"number"
        },
        "minimumAmountInSecondaryCurrency":{
            "description":"Minimum amount which should be included in refund method's where refund method currency code = alternate currency code",
            "type":"number"
        },
        "minimumAmountInPrimaryCurrency":{
            "description":"Minimum amount which should be included in refund method's where refund method currency code = order's priceListGroup currency code",
            "type":"number"
        },
        "totalRefundAmount":{
            "description":"Total refund amount in order's priceListGroup currency",
            "type":"number"
        },
        "remainingRefundAmountInSecondaryCurrency":{
            "description":"Remaining refund amount which can be adjusted/included in refund method's where refund method currency code = alternate currency code",
            "type":"number"
        }
    }
}

Example Response (application/json)

{
    "remainingRefundAmountInPrimaryCurrency":0,
    "minimumAmountInSecondaryCurrency":17.42,
    "minimumAmountInPrimaryCurrency":53,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccagentui/v1/returnRequests/900001/calculateRemainingRefund"
        }
    ],
    "totalRefundAmount":53,
    "remainingRefundAmountInSecondaryCurrency":0
}

Default Response

The error response

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