getRefunds
Get all refund requests for an order. 🔐 This method requires authorization.
Description
Fetches the refund requests of the order with the given id. Resolves to an array of IRefundRequest objects.
.getRefunds(
);
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
Status of the refund request: pending, approved, rejected or cancelled.
amount: number
Refund amount.
note: string
Refund note.
products: Record<string, IRefundProduct>
Refund details keyed by product ID.
orderId: number
ID of the order.
orderStorageId: number
ID of the order storage.
userId: number
User ID.
orderStorage: unknown
Order storage of the request: id, identifier and localizeInfos.
user: unknown
User who made the request: id and identifier.