get
https://{subdomain}.myshoplaza.com/openapi/2025-06/orders//refund
Requiresread_orderaccess scope. More access scope
The Get Order's Refund Record retrieve detailed refund information for a specific order.
This API is especially useful for:
- Viewing complete refund history for an order
- Reconciling financial records for specific transactions
- Investigating refund status and details
Request Parameters
Public Request Parameters
Path Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
order_id | string | Yes | Unique identifier of the order | "ord_123456789" |
Response Explanation
Public Response Parameters
Successful Response
| Parameter | Type | Example | Description |
|---|---|---|---|
code | string | "success" | API response status code |
message | string | "Refund records retrieved" | Response message |
data.order_financial_status | string | "refunded" | Financial status of the order |
data.order_status | string | "fulfilled" | Current order status |
data.records | array[object] | - | Array of refund records |
data.records.id | string | "ref_123456" | Refund record ID |
data.records.refund_price | string | "100.00" | Total refund amount |
data.records.refund_shipping | string | "10.00" | Shipping cost refund |
data.records.refund_status | string | "finished" | Current status |
data.records.created_at | string | "2025-01-15T10:30:00Z" | Creation timestamp |
data.records.refund_line_items | array[object] | - | Refunded items |
data.records.refund_line_items.line_item_id | string | "li_123" | Line item ID |
data.records.refund_line_items.refund_quantity | int32 | 1 | Quantity refunded |
data.records.payment_details | array[object] | - | Payment refund details |
data.records.payment_details.payment_method | string | "credit_card" | Payment method |
data.records.payment_details.refund_price | string | "100.00" | Amount refunded |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | Error message |