Saltar al contenido

Marca o pedido sobre a carta como feito (recepção)

POST/api/parcels/parcels/{parcelId}/request/complete

Auth
Requiere token
Clave de API:
parcels:delete
X-CommunityId
X-CommunityId Envía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.

A equipe (owner, admin, moderador e financeiro). Fecha a carta conforme o pedido pendente, numa transação: `PICKUP` → `PICKED_UP`, `FORWARD` → `FORWARDED` (com `trackingCode` e `carrier` opcionais, até 80 caracteres) e `DISCARD` → `DISCARDED`; o pedido passa a `DONE`. Encaminhada: quem pediu recebe o e-mail "correspondência encaminhada" pela fila, com o rastreio. Sem pedido pendente: 409 `noPendingRequest`; carta já fechada: 409.

Parámetros

NombreDóndeTipoDescripción
parcelIdobligatoriopathstring (uuid)

Headers

NombreTipoDescripción
X-CommunityIdopcionalstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Cuerpo de la solicitud application/json

NombreTipoDescripción
trackingCodeopcionalstringmax 80
carrieropcionalstringmax 80

Respuestas

CódigoDescripción
200Pedido feito e carta fechada.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`).
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
409Conflito com o estado atual do recurso.
500Erro interno do servidor.

Ejemplo con curl

curl -X POST "https://api.memberfy.net/api/parcels/parcels/<parcelId>/request/complete" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{}'