Pular para o conteúdo principal

createRefundRequest

Cria uma solicitação de reembolso de um pedido. 🔐 Este método requer autorização.

Descrição​

Cria uma solicitação de reembolso para o pedido com o id informado. Resolve para true em caso de sucesso.

Em body.products, liste os produtos a reembolsar como um mapa de id do produto para { quantity }; note é opcional.

O pedido precisa pertencer ao usuário e estar totalmente pago, e só pode ter uma solicitação de reembolso pendente por vez. Para alterar uma solicitação pendente, cancele-a com cancelRefundRequest() e crie uma nova.

.createRefundRequest(

,

);

Esquema de parâmetros​

Esquema

id(required): number
ID do pedido.
exemplo: 1

body(required): ICreateRefundRequest
Dados da solicitação de reembolso.

body.products(required): Record<string, IRefundProduct>
Detalhes do reembolso indexados por ID do produto.
exemplo:

{ "146": { "quantity": 1 } }

body.note: string
Observação anexada à solicitação de reembolso. Obrigatória pela API (o SDK a tipa como opcional para manter a compatibilidade retroativa — passe-a para evitar um 400).
exemplo: "test"

Exemplos​

Exemplo mínimo​

const response = await Orders.createRefundRequest(476, {
products: { '2957': { quantity: 1 } },
note: 'Damaged on delivery',
});

Exemplo de resposta​

true