Workers

A API permite leitura dos clientes e tipos liberados para sua conta. Só aceita GET e não envia eventos, não faz retry e não altera pedidos ou configurações. Permissões são conferidas a cada requisição, inclusive nas chaves manuais.

O endereço acompanha a origem desta página. O guia não confirma se a API ou seu token já estão configurados neste ambiente.

Da credencial à consulta

1. Gere sua chave em Minha API e copie para seu consumidor interno.
2. Consulte Clientes e copie o ID literal da loja.
3. Use Pedidos, Resumo do período ou NOK atual conforme a leitura necessária.

Execute apenas em um ambiente interno. Configure READ_API_TOKEN de forma privada fora deste painel, sem gravar o valor no histórico do shell. O comando usa essa variável, não um token embutido. Substitua o ID ilustrativo pelo inventário antes de executar.

Inventário somente dos clientes autorizados, com clients, total e nextCursor. Cada cliente traz cliente, script_name e has_database. Aceita só limit e cursor. Um worker sem banco continua no inventário, mas não tem pedidos consultáveis.

Parâmetros

Envie cada parâmetro uma vez. Valores vazios ou desconhecidos retornam 400.

Retorna orders, totals e nextCursor. Traz IDs, status técnico, valores, origem e datas, sem payload ou dados pessoais. Preserve os IDs textuais, inclusive zeros à esquerda. totals cobre todo o filtro na primeira página, não só as linhas retornadas. Nas continuações é null.

totals traz total_count, total_value, processed_count e processed_value. VTEX pode incluir siblings_count. O valor processado usa confirm_value quando existe, senão value. Os opcionais ausentes são null.

Parâmetros

Envie cada parâmetro uma vez. Valores vazios ou desconhecidos retornam 400.

Retorna cliente, date_from, date_to e totals do filtro completo sem listar pedidos. Aceita os filtros de pedidos, mas não aceita limit nem cursor.

Datas omitidas significam histórico sem aquele limite, não D-1. Os totais seguem o contrato de pedidos, inclusive o campo opcional siblings_count em VTEX.

Parâmetros

Envie cada parâmetro uma vez. Valores vazios ou desconhecidos retornam 400.

Não aceita parâmetros. É um snapshot corrente de todos os pedidos armazenados do cliente, não é D-1 nem uma série histórica. nok_count exclui retidos. held_count conta os retidos que nunca foram tentados e ainda estão na janela de atraso. snapshot_at marca o início da leitura, sem garantir isolamento entre consultas.

revenue_ok usa value pela regra atual de stats, não a regra de valor processado dos totais. As leituras de stats e retidos são separadas.

Parâmetros

Não aceita parâmetros de consulta.

Crie um nó HTTP Request. Em uma credencial privada Header Auth, informe o nome do header e guarde o valor com o token recebido do administrador. Selecione essa credencial no nó. O placeholder abaixo não é um token válido. Não cole o segredo no campo URL, no código do fluxo nem neste painel.

O nó retorna a primeira página de pedidos do intervalo ilustrativo. Para continuar, repita o GET com o nextCursor da resposta, intacto no query parameter cursor, sem mudar os filtros. Pare quando vier null.