Marca o pedido sobre a carta como feito (recepção)
POST/api/parcels/parcels/{parcelId}/request/complete
- Auth
- Jeton requis
- Clé d’API:
- parcels:delete
- X-CommunityId
X-CommunityIdEnvoyez le X-CommunityId de la communauté où l’opération a lieu.
Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.
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.
Paramètres
| Nom | Emplacement | Type | Description |
|---|---|---|---|
parcelIdobligatoire | path | string (uuid) |
En-têtes
| Nom | Type | Description |
|---|---|---|
X-CommunityIdfacultatif | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Corps de la requête application/json
| Nom | Type | Description |
|---|---|---|
trackingCodefacultatif | string | max 80 |
carrierfacultatif | string | max 80 |
Réponses
| Statut | Description |
|---|---|
200 | Pedido feito e carta fechada. |
400 | Requisição inválida — falha de validação. |
401 | Token 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`). |
403 | Autenticado, mas sem permissão para esta operação. |
404 | Recurso não encontrado. |
409 | Conflito com o estado atual do recurso. |
500 | Erro interno do servidor. |
Exemple 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 '{}'