API atual/Referência completa/Devoluções e contestações

Política e motivos

Prazo de devolução, motivo obrigatório, bônus da carteira e lista de motivos.

Duas rotas de apoio para montar o formulário de devolução: a política da loja (prazo, se o motivo é obrigatório, bônus por receber como crédito) e a lista de motivos que o cliente pode escolher. Consulte as duas ao abrir a tela de devolução.

GET/api/v1/storefront/returns/policyCliente

Política de devolução da loja

bash

curl "$BASE_URL/api/v1/storefront/returns/policy" \
  -H "Authorization: Bearer $TOKEN"

200Política

json

{ "window_days": 7, "require_reason": true, "wallet_bonus_bps": 0 }

Campos da resposta

window_daysinteger

Quantos dias depois da entrega o cliente pode pedir devolução.

require_reasonboolean

true quando a loja exige motivo (reason_id ou reason).

wallet_bonus_bpsinteger

Bônus, em pontos-base (1 bps = 0,01%), que a loja dá a quem escolhe receber o reembolso na carteira (refund_destination: wallet). 500 = 5%. 0 quando não há bônus.

GET/api/v1/storefront/returns/reasonsCliente

Motivos de devolução disponíveis

bash

curl "$BASE_URL/api/v1/storefront/returns/reasons" \
  -H "Authorization: Bearer $TOKEN"

200Motivos

json

{
  "reasons": [
    { "id": "0bc9dc6e-3655-44bc-96ba-b2645336a403", "name": "Defective product", "name_pt_br": "Produto com defeito", "position": 1, "is_active": true },
    { "id": "2a8bed80-7f13-49a0-96d3-cc35e103c6d2", "name": "Wrong item received", "name_pt_br": "Item errado recebido", "position": 2, "is_active": true }
  ]
}

Campos da resposta

reasonsarray

Só motivos ativos, em ordem de position.

iduuid

É o reason_id a enviar em Pedir devolução.

namestring

Nome em inglês.

name_pt_brstring

Nome em português. Pode vir vazio em motivo criado só em um idioma: nesse caso use name.

Erros

Status	Quando	Corpo
401	Sem token, ou token inválido ou expirado	`{"error":"missing authorization header"}` / `{"error":"invalid or expired token"}`
403	Módulo `returns` desligado na loja	`{"error":"module_disabled","module":"returns"}`
500	Falha ao ler	`{"error":"failed to list reasons","detail":"..."}`

Veja também

Política e motivos

Prazo de devolução, motivo obrigatório, bônus da carteira e lista de motivos.

GET/api/v1/storefront/returns/policyCliente

Política de devolução da loja

bash

curl "$BASE_URL/api/v1/storefront/returns/policy" \
  -H "Authorization: Bearer $TOKEN"

200Política

json

{ "window_days": 7, "require_reason": true, "wallet_bonus_bps": 0 }

Campos da resposta

window_daysinteger

Quantos dias depois da entrega o cliente pode pedir devolução.

require_reasonboolean

true quando a loja exige motivo (reason_id ou reason).

wallet_bonus_bpsinteger

Bônus, em pontos-base (1 bps = 0,01%), que a loja dá a quem escolhe receber o reembolso na carteira (refund_destination: wallet). 500 = 5%. 0 quando não há bônus.

GET/api/v1/storefront/returns/reasonsCliente

Motivos de devolução disponíveis

bash

curl "$BASE_URL/api/v1/storefront/returns/reasons" \
  -H "Authorization: Bearer $TOKEN"

200Motivos

json

{
  "reasons": [
    { "id": "0bc9dc6e-3655-44bc-96ba-b2645336a403", "name": "Defective product", "name_pt_br": "Produto com defeito", "position": 1, "is_active": true },
    { "id": "2a8bed80-7f13-49a0-96d3-cc35e103c6d2", "name": "Wrong item received", "name_pt_br": "Item errado recebido", "position": 2, "is_active": true }
  ]
}

Campos da resposta

reasonsarray

Só motivos ativos, em ordem de position.

iduuid

É o reason_id a enviar em Pedir devolução.

namestring

Nome em inglês.

name_pt_brstring

Nome em português. Pode vir vazio em motivo criado só em um idioma: nesse caso use name.

Erros

Status	Quando	Corpo
401	Sem token, ou token inválido ou expirado	`{"error":"missing authorization header"}` / `{"error":"invalid or expired token"}`
403	Módulo `returns` desligado na loja	`{"error":"module_disabled","module":"returns"}`
500	Falha ao ler	`{"error":"failed to list reasons","detail":"..."}`