Criar comentário

POST https://.account-name.krzlabs.io/api/v1/orders/:id/comments

Cria um novo comentário no pedido.

---

Body Params

Field	Type	Description	Optional	Searchable
order_code	string	Código do pedido associado ao comentário	required	false
user_id	string	Identificador único do usuário que fez o comentário	required	false
user_name	string	Nome do usuário que fez o comentário	required	false
message	string	Mensagem ou texto do comentário	required	false
attachments	Array(Object)	Lista de anexos do comentário, contendo URL opcional e chave(s) do arquivo. Exemplo: Requer duas chaves: url: string (not required) keys: string (required)	required	false
metadata	Object	Dados adicionais relacionados ao comentário em formato chave-valor	required	false

Field	Type	Description	Optional	Searchable
order_code	string	Código do pedido associado ao comentário	required	false
user_id	string	Identificador único do usuário que fez o comentário	required	false
user_name	string	Nome do usuário que fez o comentário	required	false
message	string	Mensagem ou texto do comentário	required	false
attachments	Array(Object)	Lista de anexos do comentário, contendo URL opcional e chave(s) do arquivo. Exemplo: Requer duas chaves: url: string (not required) keys: string (required)	required	false
metadata	Object	Dados adicionais relacionados ao comentário em formato chave-valor	required	false

Exemplo em JSON

{
  "order_code": "ORD-20250813-001",
  "user_id": "user-12345",
  "user_name": "João Silva",
  "message": "Olá, preciso de informações sobre o pedido.",
  "attachments": [
    {
      "url": "https://exemplo.com/arquivo1.pdf",
      "keys": "invoice, pdf"
    },
    {
      "keys": "screenshot"
    }
  ],
  "metadata": {
    "priority": "high",
    "channel": "email"
  }
}

---

Response

Resposta de sucesso

200

Successfully retrieved API registry entry.

Field	Type	Description	Optional	Searchable
order_code	string	Código do pedido associado ao comentário	required	false
user_id	string	Identificador único do usuário que fez o comentário	required	false
user_name	string	Nome do usuário que fez o comentário	required	false
message	string	Mensagem ou texto do comentário	required	false
attachments	Array(Object)	Lista de anexos do comentário, contendo URL opcional e chave(s) do arquivo. Exemplo: Requer duas chaves: url: string (not required) keys: string (required)	required	false
metadata	Object	Dados adicionais relacionados ao comentário em formato chave-valor	required	false

Resposta de erro

400

Bad Request

Field	Type	Description
code	Number	Código da resposta http
kind	String	Tipo de mensagem
name	String	Nome da exceção lançada pela plataforma
title	String	Titulo do erro lançado pela plataforma
message	String	Mensagem indicando o probloma ocorrido
solution	String	Mensagem indicando uma possível solução para o problema