Devolve a encomenda ao remetente
POST/api/parcels/parcels/{parcelId}/return
- Auth
- Requiere token
- X-CommunityId
X-CommunityIdEnví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, 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.
Parámetros
| Nombre | Dónde | Tipo | Descripción |
|---|---|---|---|
parcelIdobligatorio | path | string (uuid) |
Headers
| Nombre | Tipo | Descripción |
|---|---|---|
X-CommunityIdopcional | string (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
| Nombre | Tipo | Descripción |
|---|---|---|
reasonobligatorio | string | max 200 |
Respuestas
| Código | Descripción |
|---|---|
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. |
Ejemplo con 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"}'