Skip to content

List refund requests

GET
/api/v1/business/website/orders/refunds/

The shopper's refund requests across all orders.

Authorizations

apiKey

Your business API key (sb_live_*) — identifies which store the request is for. Required on every /api/v1/business/website/ request.

Type
API Key (header: X-Periscale-Key)
+
shopperToken

The shopper's access token from the shopper authentication endpoints. Required for cart, checkout, orders, and account actions.

Type
HTTP (bearer)

Responses

Refund requests.

application/json
JSON
{
  
"status": true,
  
"status_code": 0,
  
"message": "string",
  
"data": [
  
  
{
  
  
  
"id": 0,
  
  
  
"order_id": 0,
  
  
  
"order_number": "string",
  
  
  
"status": "string",
  
  
  
"reason": "string",
  
  
  
"amount": "string",
  
  
  
"proof_files": [
  
  
  
  
"string"
  
  
  
],
  
  
  
"admin_note": "string",
  
  
  
"refund_method": "string",
  
  
  
"reviewed_at": "string",
  
  
  
"created_at": "string"
  
  
}
  
]
}

Playground

Server
Authorization

Samples

Powered by VitePress OpenAPI

© Periscale