Document Wake: filtros na consulta e identificador de origem

Anteriormente, a listagem dos registros de uma entidade no Document Wake ocorria de forma sequencial, paginada de 50 em 50. 

Para lojas com grande volume de dados, localizar um registro específico exigia baixar toda a base e aplicar filtros no front-end, gerando requisições pesadas, perda de performance e dependência de código customizado em cada projeto. Além disso, não havia um vínculo direto entre o documento na Wake e o registro correspondente no ERP do cliente, já que a plataforma utilizava apenas identificadores numéricos próprios.

Com esta atualização, a consulta passa a aceitar filtros por código de origem e intervalo de datas, além de permitir que cada documento carregue o identificador já utilizado no sistema de origem da loja, otimizando a busca e eliminando varreduras desnecessárias.

O que mudou?

• Identificador de Origem (externalId): Ao criar um documento, o lojista pode associar o código já utilizado no seu sistema interno (código de vendedor, matrícula, SKU do ERP). O parâmetro é opcional, aceita até 50 caracteres, é imutável após a criação e único entre os documentos ativos da mesma entidade.
• Filtros na API Pública: A consulta por nome da entidade passa a aceitar filtros por externalId (até 50 códigos por requisição) e por intervalo de datas de cadastro (createdFrom / createdTo), combináveis entre si e com a paginação.
• Filtros na Storefront API: A query documents foi atualizada com os mesmos parâmetros (externalIds, createdAt_gte, createdAt_lte), permitindo que a vitrine consulte diretamente o registro necessário.
• Propriedades Fora do Schema: Habilitação da propriedade allowAdditionalProperties, liberando o registro de campos adicionais sem exigir a alteração prévia do schema a cada novidade da integração.
• Mensagens de Erro Descritivas: Respostas de erro mais precisas em casos de recursos não habilitados, parâmetros de data incorretos ou listas de códigos excedidas, agilizando diagnósticos técnicos.
• Base para Busca por Conteúdo: Os documentos passam a ser indexados, aceitando a marcação filterable em até 8 propriedades por entidade, preparando a base para buscas avançadas por conteúdo.

Principais Benefícios:

• Consulta Direta e Sem Varredura: A loja busca e recebe exclusivamente o registro necessário, eliminando a transferência de bases completas para o navegador.
• Integração de Ponta a Ponta: O mesmo código do ERP identifica o documento na plataforma Wake, dispensando mapeamentos paralelos de IDs e simplificando a sincronização.
• Menos Customização por Projeto: Filtros nativos via API reduzem a necessidade de desenvolvimentos específicos no código da vitrine.
• Performance na Vitrine: Carregamento otimizado de dados pontuais, garantindo respostas mais rápidas em lojas com alto volume de registros.
• Diagnóstico Rápido: Respostas de erro detalhadas reduzem o tempo gasto em suporte durante novas integrações.

Ainda sobrou alguma dúvida ou quer entender todos os detalhes de configuração e começar a aplicar agora mesmo? Confira o passo a passo completo na nossa documentação oficial:
🔗 API Pública 
🔗Storefront API
🔗Filtros na consulta e identificador de origem

Publicado em 21/09/2026