Devolve a encomenda ao remetente
POST/api/parcels/parcels/{parcelId}/return
- Auth
- Jeton requis
- Clé d’API:
- parcels:write
- 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, financeiro). `reason` obrigatório (400 sem, até 200 caracteres). A encomenda passa a `RETURNED` (nada é apagado, o registro fica com o motivo) e o código de retirada some. 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 |
|---|---|---|
reasonobligatoire | string | max 200 |
Réponses
| Statut | Description |
|---|---|
200 | Encomenda devolvida. |
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>/return" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{"reason":"string"}'