API legada/Referência completa/App do seller (1.0)

Chats

Lista as conversas do seller com a loja e envia mensagens ou abre uma conversa nova.

Um chat (conversa) é um fio de mensagens entre o seller e a administração da loja, por exemplo para tirar dúvidas de repasse ou de cadastro. Cada fio tem um assunto (subject) e um contador de mensagens não lidas.

GET lista as conversas do usuário. POST faz duas coisas conforme o corpo: com thread_id envia uma mensagem numa conversa que já existe; sem thread_id abre uma conversa nova (e então subject é obrigatório). A conversa aberta por aqui é endereçada à administração da loja e não fica ligada ao seller, então ela pode não aparecer na lista devolvida pelo GET; guarde o thread_id da resposta.

Listar conversas

GET/api/v1.0/vendor_chatsSeller

Listar conversas

Parâmetros de consulta

pageintegerpadrão: 1

Página, a partir de 1.

items_per_pageintegerpadrão: 10

Itens por página, de 1 a 100. De 101 a 250 volta com 20 itens. Acima de 250, menor que 1 ou texto vira 10.

GET/api/vendor_chatsSeller

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/vendor_chats. Use este caminho se o seu cliente já foi escrito para ele.

GET/api/v1.0/vn_chatsSeller

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/vendor_chats. Use este caminho se o seu cliente já foi escrito para ele.

GET/api/vn_chatsSeller

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/vendor_chats. Use este caminho se o seu cliente já foi escrito para ele.

Enviar mensagem ou abrir conversa

POST/api/v1.0/vendor_chatsSeller

Enviar mensagem ou abrir conversa

Corpo da requisição

bodystringobrigatório

Texto da mensagem. Obrigatório.

thread_idstring

Id (UUID) da conversa existente. Se enviado, a mensagem entra nela.

subjectstring

Assunto da conversa nova. Obrigatório quando não há thread_id.

POST/api/vendor_chatsSeller

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de POST /api/v1.0/vendor_chats. Use este caminho se o seu cliente já foi escrito para ele.

POST/api/v1.0/vn_chatsSeller

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de POST /api/v1.0/vendor_chats. Use este caminho se o seu cliente já foi escrito para ele.

POST/api/vn_chatsSeller

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de POST /api/v1.0/vendor_chats. Use este caminho se o seu cliente já foi escrito para ele.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1.0/vendor_chats" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "subject": "Dúvida sobre repasse",
  "body": "Bom dia! Quando sai o repasse de setembro?"
}'

Resposta

200Listar conversas

json

{
  "status": 200,
  "data": {
    "success": true,
    "message": "",
    "threads": [
      {
        "thread_id": "7d8e1c52-3e55-4d0f-8a9e-5a8f6b0c2d11",
        "subject": "Dúvida sobre repasse",
        "status": "A",
        "unread_count": 1,
        "last_message": "Bom dia! O repasse sai dia 10.",
        "updated_at": "2026-10-11T13:21:09Z"
      }
    ]
  }
}

Campos da resposta (lista)

data.threadsarray

Conversas da página. A resposta não traz bloco de paginação. Cada item: thread_id (UUID), subject, status, unread_count (mensagens não lidas), last_message (prévia da última mensagem) e updated_at (RFC 3339).

200Conversa criada

json

{
  "status": 200,
  "data": {
    "success": true,
    "message": "Thread created",
    "thread_id": "7d8e1c52-3e55-4d0f-8a9e-5a8f6b0c2d11"
  }
}

200Mensagem enviada

json

{
  "status": 200,
  "data": {
    "success": true,
    "message": "Message sent",
    "message_id": "c1a2b3d4-0000-4000-8000-000000000001"
  }
}

Campos da resposta (envio)

data.message_idstring

Id da mensagem enviada (resposta a uma conversa existente).

data.thread_idstring

Id da conversa criada (conversa nova).

Erros

Status	Quando	Corpo de exemplo
401	Sem credencial, ou credencial inválida.	`{"status":401,"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>."}`
403	Token de cliente comum (nem seller nem administrador).	`{"status":403,"message":"Forbidden: vendor scope required"}`
200	Falta `body`.	`{"status":200,"data":{"success":false,"message":"body is required"}}`
200	Conversa nova sem `subject`.	`{"status":200,"data":{"success":false,"message":"subject is required for new threads"}}`
200	`thread_id` inexistente ou inválido.	`{"status":200,"data":{"success":false,"message":"Failed to send message: <detalhe>"}}`

Veja também

API legada/Referência completa/App do seller (1.0)

Chats

Lista as conversas do seller com a loja e envia mensagens ou abre uma conversa nova.

Listar conversas

GET/api/v1.0/vendor_chatsSeller

Listar conversas

Parâmetros de consulta

pageintegerpadrão: 1

Página, a partir de 1.

items_per_pageintegerpadrão: 10

Itens por página, de 1 a 100. De 101 a 250 volta com 20 itens. Acima de 250, menor que 1 ou texto vira 10.

GET/api/vendor_chatsSeller

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/vendor_chats. Use este caminho se o seu cliente já foi escrito para ele.

GET/api/v1.0/vn_chatsSeller

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/vendor_chats. Use este caminho se o seu cliente já foi escrito para ele.

GET/api/vn_chatsSeller

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/vendor_chats. Use este caminho se o seu cliente já foi escrito para ele.

Enviar mensagem ou abrir conversa

POST/api/v1.0/vendor_chatsSeller

Enviar mensagem ou abrir conversa

Corpo da requisição

bodystringobrigatório

Texto da mensagem. Obrigatório.

thread_idstring

Id (UUID) da conversa existente. Se enviado, a mensagem entra nela.

subjectstring

Assunto da conversa nova. Obrigatório quando não há thread_id.

POST/api/vendor_chatsSeller

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de POST /api/v1.0/vendor_chats. Use este caminho se o seu cliente já foi escrito para ele.

POST/api/v1.0/vn_chatsSeller

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de POST /api/v1.0/vendor_chats. Use este caminho se o seu cliente já foi escrito para ele.

POST/api/vn_chatsSeller

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de POST /api/v1.0/vendor_chats. Use este caminho se o seu cliente já foi escrito para ele.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1.0/vendor_chats" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "subject": "Dúvida sobre repasse",
  "body": "Bom dia! Quando sai o repasse de setembro?"
}'

Resposta

200Listar conversas

json

{
  "status": 200,
  "data": {
    "success": true,
    "message": "",
    "threads": [
      {
        "thread_id": "7d8e1c52-3e55-4d0f-8a9e-5a8f6b0c2d11",
        "subject": "Dúvida sobre repasse",
        "status": "A",
        "unread_count": 1,
        "last_message": "Bom dia! O repasse sai dia 10.",
        "updated_at": "2026-10-11T13:21:09Z"
      }
    ]
  }
}

Campos da resposta (lista)

data.threadsarray

200Conversa criada

json

{
  "status": 200,
  "data": {
    "success": true,
    "message": "Thread created",
    "thread_id": "7d8e1c52-3e55-4d0f-8a9e-5a8f6b0c2d11"
  }
}

200Mensagem enviada

json

{
  "status": 200,
  "data": {
    "success": true,
    "message": "Message sent",
    "message_id": "c1a2b3d4-0000-4000-8000-000000000001"
  }
}

Campos da resposta (envio)

data.message_idstring

Id da mensagem enviada (resposta a uma conversa existente).

data.thread_idstring

Id da conversa criada (conversa nova).

Erros

Status	Quando	Corpo de exemplo
401	Sem credencial, ou credencial inválida.	`{"status":401,"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>."}`
403	Token de cliente comum (nem seller nem administrador).	`{"status":403,"message":"Forbidden: vendor scope required"}`
200	Falta `body`.	`{"status":200,"data":{"success":false,"message":"body is required"}}`
200	Conversa nova sem `subject`.	`{"status":200,"data":{"success":false,"message":"subject is required for new threads"}}`
200	`thread_id` inexistente ou inválido.	`{"status":200,"data":{"success":false,"message":"Failed to send message: <detalhe>"}}`