VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Referência completa/Pedidos de ligação

Exemplos de pedidos de ligação

Chamadas completas para listar, consultar, criar, atualizar e excluir pedidos de ligação em /api/2.0.

Os pedidos de ligação permitem que os clientes peçam um retorno da equipe de suporte. Esta página mostra chamadas práticas para cada operação da forma API 2.0.

Obter todos os pedidos de ligação

Retorna a lista de todos os pedidos de ligação com suas propriedades. Você pode usar parâmetros de consulta, como status ou date_range, para filtrar o resultado.

GET/api/2.0/call_requestsAdmin

Retorna todos os pedidos de ligação

Exemplo de requisição

bash
curl "$BASE_URL/api/2.0/call_requests" \
  -u "$EMAIL:$API_KEY"

Obter um pedido de ligação específico

Retorna um pedido de ligação pelo ID. Este exemplo retorna o pedido com request_id=1 e todas as suas propriedades.

GET/api/2.0/call_requests/{id}Admin

Retorna um pedido de ligação específico

Parâmetros de caminho

idintegerobrigatório
O ID do pedido de ligação.

Exemplo de requisição

bash
curl "$BASE_URL/api/2.0/call_requests/1" \
  -u "$EMAIL:$API_KEY"

Criar um novo pedido de ligação

Cria um novo pedido de ligação no sistema. É obrigatório informar pelo menos email ou phone.

POST/api/2.0/call_requestsAdmin

Cria um novo pedido de ligação

Corpo da requisição

emailstring
E-mail do cliente. Obrigatório se phone não for informado.
phonestring
Telefone do cliente. Obrigatório se email não for informado.
namestring
Nome do cliente.
time_fromstring
Horário preferido para ligar (início).
time_tostring
Horário preferido para ligar (fim).
user_idinteger
ID do usuário associado.
order_idinteger
ID do pedido associado.
product_idinteger
ID do produto associado.
timestampinteger
Momento do pedido.
statusstring
Status atual do pedido de ligação.
notesstring
Observações adicionais.
cart_productsarray
Produtos do carrinho do cliente. Veja Produtos do carrinho.

Exemplo de requisição

Este exemplo cria um novo pedido de ligação de John Doe, que pede para ser contatado entre 9h e 10h no telefone informado.

bash
curl -X POST "$BASE_URL/api/2.0/call_requests" \
  -u "$EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "phone": "+7(999)111-22-33",
  "name": "John Doe",
  "time_from": "9:00",
  "time_to": "10:00"
}'

Resposta

201Pedido de ligação criado
json
{
  "request_id": 5
}

Atualizar um pedido de ligação

Atualiza um pedido de ligação existente. Os campos que você pode alterar são user_id (ID do usuário associado), order_id (ID do pedido associado), product_id (ID do produto associado), status (status atual do pedido de ligação) e notes (observações adicionais).

PUT/api/2.0/call_requests/{id}Admin

Atualiza um pedido de ligação existente

Parâmetros de caminho

idintegerobrigatório
O ID do pedido de ligação.

Exemplo de requisição

Este exemplo muda o status do pedido de ligação com request_id=5 para "No Answer" (sem resposta) e adiciona a observação correspondente.

bash
curl -X PUT "$BASE_URL/api/2.0/call_requests/5" \
  -u "$EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "no_answer",
  "notes": "John didn'\''t answer the call"
}'

Resposta

200Pedido de ligação atualizado
json
{
  "request_id": 5
}

Excluir um pedido de ligação

Exclui um pedido de ligação específico do sistema. Este exemplo exclui o pedido com request_id=5.

DELETE/api/2.0/call_requests/{id}Admin

Exclui um pedido de ligação

Parâmetros de caminho

idintegerobrigatório
O ID do pedido de ligação.

Exemplo de requisição

bash
curl -X DELETE "$BASE_URL/api/2.0/call_requests/5" \
  -u "$EMAIL:$API_KEY"

Erros

StatusDescrição
204 No ContentO pedido de ligação foi excluído com sucesso.
400 Bad RequestNão foi possível excluir o pedido de ligação.
404 Not FoundO pedido de ligação informado não existe.
A exclusão é permanente

Excluir um pedido de ligação é permanente e não pode ser desfeito. Confirme que você tem as informações necessárias antes de continuar.

Veja também

  • Endpoints de pedidos de ligação
  • Campos do pedido de ligação
Anterior
Produtos do carrinho
Próxima
Vendedores
Nesta página
  • Obter todos os pedidos de ligação
  • Exemplo de requisição
  • Obter um pedido de ligação específico
  • Exemplo de requisição
  • Criar um novo pedido de ligação
  • Exemplo de requisição
  • Resposta
  • Atualizar um pedido de ligação
  • Exemplo de requisição
  • Resposta
  • Excluir um pedido de ligação
  • Exemplo de requisição
  • Erros
  • Veja também