Aller au contenu

Fila e histórico de encomendas (equipe)

GET/api/parcels/spaces/{spaceId}/parcels

Auth
Jeton requis
Qui peut l’appeler:
owner
admin
moderator
finance
Clé d’API:
parcels:read
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). Filtros: `status`, `kind`, `q` (nome do destinatário, remetente, transportadora ou rastreio), `stalled` (só as `RECEIVED` paradas há pelo menos o prazo do space), `recipientMemberId`, `recipientCompanyId`, `from` e `to` (datas `AAAA-MM-DD` no fuso da comunidade, pelo dia do recebimento). Mais novas primeiro. **Nenhuma resposta traz o código de retirada**, só `hasLockerCode`. Fotos vêm só com os ids; os links assinados saem em `GET /api/media/{id}/url` ou no detalhe.

Paramètres

NomEmplacementTypeDescription
spaceIdobligatoirepathstring (uuid)
statusfacultatifqueryRECEIVED | PICKED_UP | RETURNED | DISCARDED
kindfacultatifqueryLETTER | PACKAGE | OTHER
qfacultatifquerystring
stalledfacultatifqueryboolean
recipientMemberIdfacultatifquerystring (uuid)
recipientCompanyIdfacultatifquerystring (uuid)Só as encomendas desta empresa.
fromfacultatifquerystring
tofacultatifquerystring
pagefacultatifqueryinteger
limitfacultatifqueryinteger

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.

Réponses

StatutDescription
200Encomendas da página.
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.
500Erro interno do servidor.

Exemple curl

curl -X GET "https://api.memberfy.net/api/parcels/spaces/<spaceId>/parcels" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"