Confirma a retirada
POST/api/parcels/parcels/{parcelId}/pickup
- Auth
- Richiede un token
- Chi può:
- owner
- admin
- moderator
- finance
- 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.
**Equipe** (owner, admin, moderador, financeiro): `method: STAFF` (padrão; `pickedUpByName` é quem veio buscar, padrão o destinatário) ou `THIRD_PARTY` (exige `pickedUpByName`). **O próprio destinatário**: `method: SELF`, só se o space **não** exige confirmação da equipe (`requireStaffConfirmation`; ligado, 403); na encomenda de outro membro: 404. Guarda `pickedUpAt`, `pickupMethod`, quem retirou e quem confirmou, e **apaga o código de retirada**. **Atômica e idempotente:** dois pedidos ao mesmo tempo fecham uma vez; o outro recebe `200` com `alreadyClosed: true` e `closedBy`.
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 |
|---|---|---|
methodfacoltativo | STAFF | SELF | THIRD_PARTY | |
pickedUpByNamefacoltativo | string | Até 120 caracteres. |
Risposte
| Codice | Descrizione |
|---|---|
200 | Retirada registrada (ou já registrada, `alreadyClosed: true`). |
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 POST "https://api.memberfy.net/api/parcels/parcels/<parcelId>/pickup" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'