API legada/Referência completa/Registros da loja (1.0)

Pedidos de ligação

Lista, lê, registra e apaga os pedidos de ligação ("me liga de volta") feitos por clientes.

Um pedido de ligação é o recado "me liga de volta" que um visitante ou cliente deixa na loja: nome, telefone e, opcionalmente, o pedido ou produto de que trata. A equipe de atendimento liga depois. Estas rotas servem a um CRM ou a um sistema de atendimento que quer importar esses recados ou registrar outros que chegaram por outro canal (um formulário externo, o telefone).

São rotas de administrador. A API guarda o recado, mas não tem rota para mudar a situação dele: todo recado criado por aqui fica com situação new. Para marcar como atendido, apague o recado ou controle a situação no seu sistema.

GET/api/v1.0/call_requestsAdmin

Listar pedidos de ligação (API 1.0)

Do mais novo para o mais antigo.

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 250. Fora disso volta a 10.

GET/api/v1.0/call_requests/{id}Admin

Ler um pedido de ligação (API 1.0)

Parâmetros de caminho

iduuidobrigatório

Id do pedido (request_id).

POST/api/v1.0/call_requestsAdmin

Registrar um pedido de ligação (API 1.0)

Registra o recado com a situação new e devolve o id.

Corpo da requisição

namestringobrigatório

Nome de quem pediu a ligação.

phonestringobrigatório

Telefone, no formato que a equipe usar. Não é validado.

notesstring

Observação (melhor horário, assunto).

order_idstring

Pedido de que o recado trata (UUID).

product_idstring

Produto de que o recado trata (UUID).

user_idstring

Cliente que pediu, quando logado (UUID).

company_idstring

Seller envolvido (UUID).

DELETE/api/v1.0/call_requests/{id}Admin

Apagar um pedido de ligação (API 1.0)

Apaga o recado de vez. Responde 204 sem corpo.

Parâmetros de caminho

iduuidobrigatório

Id do pedido.

GET/api/call_requestsAdmin

Listar pedidos de ligação, sem o prefixo /v1.0

Idêntica a GET /api/v1.0/call_requests.

GET/api/call_requests/{id}Admin

Ler um pedido de ligação, sem o prefixo /v1.0

Idêntica a GET /api/v1.0/call_requests/{id}. O caminho aceita só o UUID.

POST/api/call_requestsAdmin

Registrar um pedido de ligação, sem o prefixo /v1.0

Idêntica a POST /api/v1.0/call_requests.

DELETE/api/call_requests/{id}Admin

Apagar um pedido de ligação, sem o prefixo /v1.0

Idêntica a DELETE /api/v1.0/call_requests/{id}. O caminho aceita só o UUID.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1.0/call_requests" \
  -u "$EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Maria Souza",
  "phone": "+5511999990000",
  "notes": "Ligar depois das 14h"
}'

Resposta

201Pedido registrado

json

{ "request_id": "a25457ab-e71f-45c0-95c7-5cfb48dc933e" }

200Lista de pedidos

json

{
  "call_requests": [
    {
      "request_id": "a25457ab-e71f-45c0-95c7-5cfb48dc933e",
      "name": "Maria Souza",
      "phone": "+5511999990000",
      "status": "new",
      "notes": "Ligar depois das 14h",
      "timestamp": 1791752782
    }
  ],
  "params": { "page": 1, "items_per_page": 10, "total_items": 1 }
}

Campos da resposta

request_iduuid

Id do pedido de ligação.

namestring

Nome de quem pediu.

phonestring

Telefone informado.

statusstring

new

Situação. Esta API só produz new.

notesstring

Observação. Vazia quando não há.

timestampinteger

Criação em Unix timestamp (segundos, UTC).

order_idstring

Pedido relacionado. Aparece só quando preenchido.

product_idstring

Produto relacionado. Aparece só quando preenchido.

user_idstring

Cliente. Aparece só na lista, quando preenchido.

company_idstring

Seller. Aparece só na lista, quando preenchido.

paramsobject

Na lista: page, items_per_page e total_items.

Erros

Status	Quando	Corpo
400	Corpo que não é JSON	`{"message":"Invalid JSON body","status":400}`
400	`name` ou `phone` ausentes	`{"message":"name and phone are required","status":400}`
401	Sem credencial	`{"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.","status":401}`
403	Credencial que não é de administrador	`{"message":"Forbidden: admin scope required","status":403}`
404	Pedido inexistente (UUID válido)	`{"message":"Call request not found","status":404}`
500	Id que não é UUID	`{"message":"Failed to get call request: ...","status":500}`
503	Recurso não habilitado na loja	`{"message":"Call requests are not enabled for this store","status":503}`

Veja também

Pedidos de ligação

Lista, lê, registra e apaga os pedidos de ligação ("me liga de volta") feitos por clientes.

GET/api/v1.0/call_requestsAdmin

Listar pedidos de ligação (API 1.0)

Do mais novo para o mais antigo.

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 250. Fora disso volta a 10.

GET/api/v1.0/call_requests/{id}Admin

Ler um pedido de ligação (API 1.0)

Parâmetros de caminho

iduuidobrigatório

Id do pedido (request_id).

POST/api/v1.0/call_requestsAdmin

Registrar um pedido de ligação (API 1.0)

Registra o recado com a situação new e devolve o id.

Corpo da requisição

namestringobrigatório

Nome de quem pediu a ligação.

phonestringobrigatório

Telefone, no formato que a equipe usar. Não é validado.

notesstring

Observação (melhor horário, assunto).

order_idstring

Pedido de que o recado trata (UUID).

product_idstring

Produto de que o recado trata (UUID).

user_idstring

Cliente que pediu, quando logado (UUID).

company_idstring

Seller envolvido (UUID).

DELETE/api/v1.0/call_requests/{id}Admin

Apagar um pedido de ligação (API 1.0)

Apaga o recado de vez. Responde 204 sem corpo.

Parâmetros de caminho

iduuidobrigatório

Id do pedido.

GET/api/call_requestsAdmin

Listar pedidos de ligação, sem o prefixo /v1.0

Idêntica a GET /api/v1.0/call_requests.

GET/api/call_requests/{id}Admin

Ler um pedido de ligação, sem o prefixo /v1.0

Idêntica a GET /api/v1.0/call_requests/{id}. O caminho aceita só o UUID.

POST/api/call_requestsAdmin

Registrar um pedido de ligação, sem o prefixo /v1.0

Idêntica a POST /api/v1.0/call_requests.

DELETE/api/call_requests/{id}Admin

Apagar um pedido de ligação, sem o prefixo /v1.0

Idêntica a DELETE /api/v1.0/call_requests/{id}. O caminho aceita só o UUID.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1.0/call_requests" \
  -u "$EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Maria Souza",
  "phone": "+5511999990000",
  "notes": "Ligar depois das 14h"
}'

Resposta

201Pedido registrado

json

{ "request_id": "a25457ab-e71f-45c0-95c7-5cfb48dc933e" }

200Lista de pedidos

json

{
  "call_requests": [
    {
      "request_id": "a25457ab-e71f-45c0-95c7-5cfb48dc933e",
      "name": "Maria Souza",
      "phone": "+5511999990000",
      "status": "new",
      "notes": "Ligar depois das 14h",
      "timestamp": 1791752782
    }
  ],
  "params": { "page": 1, "items_per_page": 10, "total_items": 1 }
}

Campos da resposta

request_iduuid

Id do pedido de ligação.

namestring

Nome de quem pediu.

phonestring

Telefone informado.

statusstring

new

Situação. Esta API só produz new.

notesstring

Observação. Vazia quando não há.

timestampinteger

Criação em Unix timestamp (segundos, UTC).

order_idstring

Pedido relacionado. Aparece só quando preenchido.

product_idstring

Produto relacionado. Aparece só quando preenchido.

user_idstring

Cliente. Aparece só na lista, quando preenchido.

company_idstring

Seller. Aparece só na lista, quando preenchido.

paramsobject

Na lista: page, items_per_page e total_items.

Erros

Status	Quando	Corpo
400	Corpo que não é JSON	`{"message":"Invalid JSON body","status":400}`
400	`name` ou `phone` ausentes	`{"message":"name and phone are required","status":400}`
401	Sem credencial	`{"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.","status":401}`
403	Credencial que não é de administrador	`{"message":"Forbidden: admin scope required","status":403}`
404	Pedido inexistente (UUID válido)	`{"message":"Call request not found","status":404}`
500	Id que não é UUID	`{"message":"Failed to get call request: ...","status":500}`
503	Recurso não habilitado na loja	`{"message":"Call requests are not enabled for this store","status":503}`