Confirma a retirada
POST/api/parcels/parcels/{parcelId}/pickup
- Auth
- Jeton requis
- Qui peut l’appeler:
- owner
- admin
- moderator
- finance
- Clé d’API:
- parcels:write
- X-CommunityId
X-CommunityIdEnvoyez le X-CommunityId de la communauté où l’opération a lieu.
Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.
**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`.
Paramètres
| Nom | Emplacement | Type | Description |
|---|---|---|---|
parcelIdobligatoire | path | string (uuid) |
En-têtes
| Nom | Type | Description |
|---|---|---|
X-CommunityIdfacultatif | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Corps de la requête application/json
| Nom | Type | Description |
|---|---|---|
methodfacultatif | STAFF | SELF | THIRD_PARTY | |
pickedUpByNamefacultatif | string | Até 120 caracteres. |
Réponses
| Statut | 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; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`). |
403 | Autenticado, mas sem permissão para esta operação. |
404 | Recurso não encontrado. |
500 | Erro interno do servidor. |
Exemple 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 '{}'