getRefunds
Getting all refund requests for an order. 🔐 This method requires authorization.
Description
This method retrieves all refund requests associated with an order. It returns a Promise that resolves to an array of IRefundRequest objects.
Orders.getRefunds(
id*);
Parameters schema
Schema
id(required): number
Order id
example: 1
Examples
Minimal example
const response = await Orders.getRefunds(476);
Example response
[]
Response schema
Schema: IRefundRequest[]
id: number
Refund request id.
createdDate: string
Creation date.
status: string
Refund status.
amount: number
Refund amount.
note: string
Refund note.
products: Record<string, unknown>
Products for refund.
orderId: number
Order id.
orderStorageId: number
Order storage id.
userId: number
User id.
orderStorage: unknown
Order storage data.
user: unknown
User data.