Confirma a retirada
POST/api/parcels/parcels/{parcelId}/pickup
- Auth
- Requires a token
- Who can call it:
- owner
- admin
- moderator
- finance
- 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.
**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`.
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 |
|---|---|---|
methodoptional | STAFF | SELF | THIRD_PARTY | |
pickedUpByNameoptional | string | Até 120 caracteres. |
Responses
| Status | Description |
|---|---|
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. |
curl example
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 '{}'