Requires read_order access scope. More access scope
The Refund List Count API retrieves the count of refund records based on the provided filters and query parameters. This enables merchants to efficiently track and analyze the volume of refund activities in their system.
This API is especially useful for:
Obtaining aggregate counts of refunds for specific order IDs
Monitoring refund statistics across different status types (pending, finished, failed)
Analyzing refund volumes within specific time periods for business reporting
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
Field
Type
Example
Description
errors
Array
[ "created_at_min time format error"]
A list of errors encountered during the request processing.
Field
Type
Example
Description
error
String
"store is not active"
Indicates an error encountered during the process
Error Detail
Status Code
Message
Possible Reason
Example Response
400
Bad Request
Invalid input format or request structure (e.g., missing required fields or incorrect data types).
Bad Request
Unauthorized
The request is missing valid authentication credentials or the credentials provided are invalid.
Unauthorized
422
Unprocessable Entity
created_at_min time input is not invalid
"created_at_min time format error"
created_at_max time input is not invalid
"created_at_max time format error"
UpdatedAtMin time input is not invalid
"UpdatedAtMin time format error"
updated_at_end time input is not invalid
"updated_at_end time format error"
API Structure Overview
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!
