Aller au contenu
memberfy
FR

Registra uma encomenda

POST/api/parcels/spaces/{spaceId}/parcels

Auth
Jeton requis
Qui peut l’appeler:
owner
admin
moderator
finance
Clé d’API:
parcels:write
X-CommunityId
X-CommunityId Envoyez 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.

Só a equipe (owner, admin, moderador e financeiro); membro recebe 403. Cria a encomenda `RECEIVED`, liga as fotos (`mediaIds`, até 5) e **enfileira o e-mail ao destinatário** (nunca na requisição; no fuso da comunidade, com miniatura de 300 px e link de 72 h se `emailIncludesPhoto`). O destinatário é **um** de dois: um membro com acesso ao space (`recipientMemberId`) ou uma empresa ativa (`recipientCompanyId`) com ao menos um funcionário com acesso (outra comunidade: 404; sem acesso: 400). Sem destinatário, com os dois, ou sem `kind`: 400 com um item em `errors` por campo. Encomenda de empresa: **um e-mail para cada funcionário atual com acesso ao space**, ou só para os admins da empresa quando ela pediu (`parcelNoticeAdminsOnly` em `PATCH /api/companies/{id}`); o lembrete segue a mesma regra. Com `lockerMode: none` os campos de locker são ignorados; com `list`, `lockerId` escolhe um locker ativo do space (o nome vai para `lockerLabel`) e `lockerLabel` é ignorado. **Idempotente** por `clientRequestId`: o segundo toque devolve a mesma encomenda (200, `alreadyRegistered: true`) sem novo e-mail. Mesma encomenda (destinatário, tipo e rastreio) em 24 h: 409 com `data.duplicateOf`, salvo com `force: true`. Cria: `201`.

Paramètres

NomEmplacementTypeDescription
spaceIdobligatoirepathstring (uuid)

En-têtes

NomTypeDescription
X-CommunityIdfacultatifstring (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

NomTypeDescription
recipientMemberIdfacultatifstring (uuid)Membro da comunidade, com acesso ao space.
recipientCompanyIdfacultatifstring (uuid)Empresa ativa da comunidade (outra comunidade, encerrada ou inexistente: 404) com ao menos um funcionário com acesso ao space (senão 400).
kindobligatoireLETTER | PACKAGE | OTHER
kindLabelfacultatifstringObrigatório com `OTHER`; até 60 caracteres.
senderNamefacultatifstring
carrierfacultatifstring
trackingCodefacultatifstring
notesfacultatifstring
lockerLabelfacultatifstringSó com `lockerMode: free`; ignorado nos outros modos.
lockerIdfacultatifstring (uuid)Só com `lockerMode: list`: um locker ativo deste space (`GET /api/parcels/spaces/{spaceId}/lockers`). Inativo, removido ou de outro space: 400. Vazio = na recepção. Ignorado nos outros modos.
lockerPickupCodefacultatifstring4 a 12 caracteres. Só com `lockerPickupCode: true` na configuração do space; ignorado fora disso.
mediaIdsfacultatifstring (uuid)[]Fotos já enviadas por `/api/media` com `purpose: parcelPhoto` e confirmadas.
clientRequestIdfacultatifstringIdempotência: o mesmo valor no mesmo space devolve a encomenda já criada (200, `alreadyRegistered: true`) e não envia outro e-mail.
forcefacultatifbooleanRegistra mesmo com a mesma encomenda (mesmo destinatário, tipo e rastreio) nas últimas 24 h.

Réponses

StatutDescription
200Já registrada com o mesmo `clientRequestId`.
201Encomenda registrada.
400Requisição inválida — falha de validação.
401Token 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`).
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
409Conflito com o estado atual do recurso.
500Erro interno do servidor.

Exemple curl

curl -X POST "https://api.memberfy.net/api/parcels/spaces/<spaceId>/parcels" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{"kind":"LETTER"}'