Corrige uma encomenda
PATCH/api/parcels/parcels/{parcelId}
- Auth
- Jeton requis
- 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.
A equipe corrige uma encomenda `RECEIVED` (tipo, remetente, transportadora, rastreio, observação, local e código de retirada; o código só se redefine, nunca se lê). Uma encomenda já fechada só se corrige por owner e admin, e sem mexer no código. Os campos de locker seguem a configuração do space. Cada correção fica no log.
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 |
|---|---|---|
kindfacultatif | LETTER | PACKAGE | OTHER | |
kindLabelfacultatif | string | |
senderNamefacultatif | string | |
carrierfacultatif | string | |
trackingCodefacultatif | string | |
notesfacultatif | string | |
lockerLabelfacultatif | string | Modo `free`. |
lockerIdfacultatif | string (uuid) | Modo `list`; nulo remove o locker. |
lockerPickupCodefacultatif | string |
Réponses
| Statut | Description |
|---|---|
200 | Encomenda corrigida. |
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 PATCH "https://api.memberfy.net/api/parcels/parcels/<parcelId>" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'