Vai al contenuto

Renomeia, reordena ou (des)ativa um locker

PATCH/api/parcels/lockers/{lockerId}

Auth
Richiede un token
Chi può:
owner
admin
X-CommunityId
X-CommunityId Invia 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.

Só owner e admin. Renomear não reescreve as encomendas antigas: elas guardam o nome que o locker tinha quando foram registradas. Locker de outra comunidade: 404.

Parametri

NomeDoveTipoDescrizione
lockerIdobbligatoriopathstring (uuid)

Header

NomeTipoDescrizione
X-CommunityIdfacoltativostring (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

NomeTipoDescrizione
namefacoltativostringmax 60
activefacoltativoboolean
positionfacoltativointeger≥ 0

Risposte

CodiceDescrizione
200Locker atualizado.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado.
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
409Conflito com o estado atual do recurso.
500Erro interno do servidor.

Esempio con curl

curl -X PATCH "https://api.memberfy.net/api/parcels/lockers/<lockerId>" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{}'