📝 Inclusão de Observação no Grupo de Pedido
/orders/groups/{orderGroupId}/observation
Adiciona uma observação interna ou registro de acompanhamento ao grupo de pedido.
📄 Descrição
Este endpoint permite registrar anotações internas ou comentários operacionais em um grupo de pedidos. O acesso exige o escopo de permissão ORDER_WRITE.
As observações são essenciais para documentar tratativas com o cliente, instruções de logística reversa ou qualquer detalhe relevante para a rastreabilidade interna da operação.
Ao salvar uma nota, o sistema registra automaticamente o identificador do usuário (administrador) responsável, permitindo saber exatamente quem incluiu cada registro de acompanhamento.
📋 Parâmetros
🏷️ Headers Obrigatórios
| Header | Valor | Descrição |
|---|---|---|
Content-Type | application/json | Tipo de conteúdo |
Authorization | Bearer {token} | Token de autenticação |
🔑 Parâmetros da URL
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| orderGroupId | integer | Sim | ID único do grupo de pedido |
📝 Parâmetros de Corpo
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| text | string | Sim | Conteúdo textual da observação. |
💡 Exemplo de Requisição
1curl --request POST \2 --url https://sua-loja-uappi.com.br/api/v3/orders/groups/456/observation \3 --header "Authorization: Bearer SEU_TOKEN_AQUI" \4 --header "Content-Type: application/json" \5 --data '{6 "text": "Cliente solicitou alteração na embalagem para presente."7 }'✅ Resposta de Sucesso
HTTP Status: 201 Created
1{2 "id": 10,3 "orderGroupId": 456,4 "userId": 5,5 "userEmail": "atendimento@loja.com.br",6 "text": "Cliente solicitou alteração na embalagem para presente.",7 "createdAt": "2026-04-27 10:30:00"8}⚠️ Possíveis Erros
> Os cenários abaixo representam os principais erros que podem ocorrer neste endpoint, servindo como referência para entendimento e tratamento das falhas.
| Código Interno | HTTP | Descrição |
|---|---|---|
| UAPPI_STORE_ORDER_GROUP_NOT_FOUND | 404 | ❌ O grupo de pedido solicitado não foi encontrado. |