Initiate a Partial Refund

Request

This API allows merchants to submit requests for partial refunds on specific products within an order. It is designed to adjust billing and chargeback processes when certain items in an order will not incur costs due to various reasons, such as promotions, errors, or customer satisfaction measures.

Bodyapplication/jsonrequired

orderViewIdinteger, (int64)required

Unique identifier for orders on Keeta platform

Example:756823555555859

shopIdinteger, (int64)required

Unique identifier of the Keeta store

Example:466663

productsArray of objects(AfterSaleProductDTO)required

A List of products designated for refund

partRefundTypeintegerrequired

This field represents the code value for the reason for initiating a "partial product refund" request within an order. Please send the appropriate code value that corresponds to the reason for initiating the "partial product refund" request in this field. The specific meanings of the codes are as follows:

Enum Value	Description
200000	indicates other unspecified reasons (requires partRefundReason)
200001	indicates slow meal preparation
200002	indicates insufficient ingredients
200003	indicates missing or incomplete delivery
200004	indicates wrong item prepared

partRefundReasonstring

This field is intended to provide a detailed textual explanation for initiating a partial refund request on specific items within an order.

For partRefundType = 200000 (Other Reasons), the partRefundReason field is mandatory and must be filled in.

For partRefundType = 200001, 200002, 200003, or 200004 (Standard Reasons), the partRefundReason field is optional and may be omitted or left empty.

Example:"Do not like"

curl -i -X POST \
  https://open.mykeeta.com/api/open/order/refund/part/apply \
  -H 'Content-Type: application/json' \
  -d '{
    "orderViewId": 756823555555859,
    "shopId": 466663,
    "products": [
      {
        "orderProductId": 1234534224,
        "refundCount": 1
      }
    ],
    "partRefundType": 200000,
    "partRefundReason": "Do not like"
  }'

Responses

Request executed successfully

Bodyapplication/json

codeintegerrequired

A numeric status identifier indicating the result of the interface call, used to determine whether the operation executed successfully.

Enum Value	Description
0	The request was executed successfully.
Non-zero value	The request execution failed. Specific error details can be viewed in the message field.

Example:0

messagestringrequired

Text description corresponding to the status code, explaining the operation result or error cause to users.

Example:"Success"

Response

{
  "code": 0,
  "message": "Success"
}