Skip to content

Partial Refundable Item Query

Request

This API is designed to retrieve detailed information about items that are eligible for partial refunds. It allows developers to access and display specific product details related to refund eligibility.

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)

A List of products designated for refund: This field should be populated with specific product information for partial refunds. If left empty, the API will return all products eligible for refund, with the refund amount set to zero.

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

Responses

Successful returns partial refundable item details.

Bodyapplication/json
codeintegerrequired

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

Enum ValueDescription
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"
dataobject(PartRefundPreviewResp)
Response
{ "code": 0, "message": "Success", "data": { "products": [ … ], "promotionInfoList": [ … ], "refundPrice": { … }, "valuationRule": "Refund formula: [Item price / (Subtotal + Top-up to minimum)] × [Actual payment amount - Tips - Platform fee - Delivery fee]" } }