createRefundRequest
Crea una solicitud de reembolso para un pedido. 🔐 Este método requiere autorización.
Descripción
Crea una solicitud de reembolso para el pedido con el id indicado. Se resuelve en true si tiene éxito.
En body.products, indica los productos que se reembolsan como un mapa de id de producto a { quantity }; note es opcional.
El pedido debe pertenecer al usuario y estar pagado por completo, y solo puede tener una solicitud de reembolso pendiente a la vez. Para cambiar una solicitud pendiente, cancélala con cancelRefundRequest() y crea una nueva.
.createRefundRequest(
,
);
Esquema de parámetros
Esquema
id(required): number
ID del pedido.
ejemplo: 1
body(required): ICreateRefundRequest
Datos de la solicitud de reembolso.
body.products(required): Record<string, IRefundProduct>
Detalles del reembolso indexados por ID de producto.
ejemplo:
{ "146": { "quantity": 1 } }
body.note: string
Nota adjunta a la solicitud de reembolso. Obligatoria para la API (el SDK la tipa como opcional para mantener la compatibilidad hacia atrás — pásala para evitar un 400).
ejemplo: "test"
Ejemplos
Ejemplo mínimo
const response = await Orders.createRefundRequest(476, {
products: { '2957': { quantity: 1 } },
note: 'Damaged on delivery',
});
Ejemplo de respuesta
true