get
https://{subdomain}.myshoplaza.com/openapi/2025-06/orders/refund_records/count
Requiresread_orderaccess scope. More access scope
The Get Refund Order Count retrieve the count of refund records based on specified filters.
This API is especially useful for:
- Getting quick statistics about refund operations
- Monitoring refund volumes by status
- Building dashboards with refund metrics
Request Parameters
Public Request Parameters
Query Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
order_ids | array[string] | No | Filter by order IDs (max 10) | ["ord_123","ord_456"] |
refund_order_ids | array[string] | No | Filter by refund record IDs (max 20) | ["ref_123","ref_456"] |
refund_statuses | array[string] | No | Filter by status: pending, finished, failed | ["finished","failed"] |
created_at_start | string | No | Filter records created after (ISO 8601) | "2025-01-01T00:00:00Z" |
created_at_end | string | No | Filter records created before (ISO 8601) | "2025-01-31T23:59:59Z" |
updated_at_start | string | No | Filter records updated after (ISO 8601) | "2025-01-15T00:00:00Z" |
updated_at_end | string | No | Filter records updated before (ISO 8601) | "2025-01-15T23:59:59Z" |
Response Explanation
Public Response Parameters
Successful Response
| Parameter | Type | Example | Description |
|---|---|---|---|
code | string | "success" | API response status code |
message | string | "Count retrieved" | Response message |
data.count | int32 | 15 | Total count of matching refund records |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | Error message |