Devolve a encomenda ao remetente
POST/api/parcels/parcels/{parcelId}/return
- Auth
- Requires a token
- X-CommunityId
X-CommunityIdSend the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.
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.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
parcelIdrequired | path | string (uuid) |
Headers
| Name | Type | Description |
|---|---|---|
X-CommunityIdoptional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Request body application/json
| Name | Type | Description |
|---|---|---|
reasonrequired | string | max 200 |
Responses
| Status | Description |
|---|---|
200 | Encomenda devolvida. |
400 | Requisição inválida — falha de validação. |
401 | Token ausente, inválido ou expirado. |
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. |
curl example
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"}'