Remove uma encomenda registrada por engano
DELETE/api/parcels/parcels/{parcelId}
- Auth
- Richiede un token
- Chi può:
- owner
- admin
- X-CommunityId
X-CommunityIdInvia l’X-CommunityId della community in cui avviene l’operazione.
Le descrizioni degli endpoint provengono dalla specifica dell’API e per ora sono in portoghese. L’interfaccia intorno è tradotta.
Só owner e admin, com `reason` obrigatório (corpo JSON). Exclusão lógica: a encomenda sai das listas, as fotos são apagadas e o log guarda quem e por quê. Encerrar uma encomenda **não** é isto: use `return`, `discard` ou `pickup`.
Parametri
| Nome | Dove | Tipo | Descrizione |
|---|---|---|---|
parcelIdobbligatorio | path | string (uuid) |
Header
| Nome | Tipo | Descrizione |
|---|---|---|
X-CommunityIdfacoltativo | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Corpo della richiesta application/json
| Nome | Tipo | Descrizione |
|---|---|---|
reasonobbligatorio | string | max 200 |
Risposte
| Codice | Descrizione |
|---|---|
200 | Encomenda removida. |
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. |
500 | Erro interno do servidor. |
Esempio con curl
curl -X DELETE "https://api.memberfy.net/api/parcels/parcels/<parcelId>" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{"reason":"string"}'