> ## Documentation Index
> Fetch the complete documentation index at: https://developers.sults.com.br/llms.txt
> Use this file to discover all available pages before exploring further.
# Changelog
> Histórico de mudanças da API do SULTS e desta documentação, da mais recente para a mais antiga
Mudanças da API do SULTS e desta documentação, da mais recente para a mais antiga. Mudanças que quebram compatibilidade aparecem em destaque, com o caminho de migração.
Este changelog começa em agosto de 2026, quando a documentação passou a registrar as mudanças de forma sistemática. Alterações anteriores da API não estão listadas aqui.
## 2026-10-19
**Os filtros de check-in e check-out da listagem de modelos de Checklist v2 mudaram de nome.** Em `GET /api/v2/checklist/template/list`, `checkinEnable` passou a ser `checkInEnabled`, e `checkoutEnable`, `checkOutEnabled`, os mesmos nomes dos campos da resposta. Se a sua integração usa esses filtros, troque os nomes.
**`closedAt` saiu da listagem de avaliações de Checklist v2.** `GET /api/v2/checklist/assessment/list` não traz mais a data de conclusão da avaliação. O `closedAt` da avaliação dentro de `GET /api/v2/checklist/action-plan/list` não mudou.
**Os tipos de questão de Checklist v2 mudaram.** Em `GET /api/v2/checklist/template/question/list` e `GET /api/v2/checklist/assessment/answer/list`, `type` usa novos valores, como `TEXT_SHORT`, `CONFORMITY`, `RATING_QUALITY_3` e `CUSTOM_SINGLE_CHOICE`, no lugar de `SHORT_TEXT`, `COMPLIANT_NON_COMPLIANT`, `QUALITY_LEVEL_3` e `CUSTOM`. A lista está no [dicionário de Checklist v2](/v2/dicionario/checklist). Nas questões sem opções, `typeSettings` vem como array vazio (`[]`), não como objeto. Ajuste as comparações da sua integração.
**Tipos e campos de Checklist v2 corrigidos na documentação, após conferência com a API.** Em `assessment/list`, `score` e `maxScore` vêm como texto. Em `template/question/list`, `maxScore` vem como texto, e a questão e a seção dela trazem `active`. Em `action-plan/list`, `howMuch` vem como texto, e o campo `where` não vem na resposta. Se a sua integração lê esses campos como número, converta o texto.
**O filtro de questão da listagem de respostas de Checklist v2 se chama `templateQuestionId`.** Em `GET /api/v2/checklist/assessment/answer/list`, o filtro `questionId` passou a ser `templateQuestionId`. Se a sua integração filtra as respostas por questão, troque o nome do parâmetro.
**O evento de mudança de prazo da timeline do plano de ação de Checklist v2 se chama `DUE_CHANGED`.** Em `GET /api/v2/checklist/action-plan/timeline/list`, o `type` `DEADLINE_CHANGED` passou a ser `DUE_CHANGED`. Se a sua integração compara com o valor antigo, troque pelo novo.
**O filtro e o campo de cancelamento das avaliações de Checklist v2 se chamam `active`, com o sentido invertido.** Em `GET /api/v2/checklist/assessment/list`, o filtro que a documentação publicava como `cancelado` passou a ser `active`: `true` (padrão) lista só as avaliações ativas, e `false`, só as canceladas. Cada avaliação traz `active`, que é `false` quando ela foi cancelada. Se a sua integração envia `cancelado` ou `canceled`, troque por `active` e inverta o valor.
**O caminho da timeline do plano de ação de Checklist v2 mudou.** `GET /api/v2/checklist/action-plan/timeline-event/list` passou a ser `GET /api/v2/checklist/action-plan/timeline/list`, com os mesmos parâmetros e a mesma resposta. Troque o caminho na sua integração.
**A resposta de `GET /api/v2/checklist/assessment/answer/list` mudou.** A questão passou a vir em `templateQuestion`, um objeto com `id` e `title`, no lugar de `question` (o título em texto) e de `questionId`. `answerTemplateOptionId` passou a ser um array de códigos e não vem nas questões sem opções. `score` e `maxScore` vêm como texto. Nos planos de ação de cada resposta (`actionPlans`), o prazo vem em `whenDate`, data sem hora (`yyyy-MM-dd`), e não em `dueDate`, como a documentação dizia. Ajuste a leitura desses campos na sua integração.
**Campos de configuração do check-in e do check-out mudaram de nome em `GET /api/v2/checklist/template/list`.** Em `checkInSettings` e `checkOutSettings`, `commentEnabled`, `signatureEnabled`, `attachmentEnabled` e `geolocationEnabled` passaram a se chamar `commentRequired`, `signatureRequired`, `attachmentRequired` e `geolocationRequired`, e indicam se o item é obrigatório. Se a sua integração lê os nomes antigos, troque pelos novos.
### Adicionado
* **Importar avaliação de checklist na API v2**: `POST /api/v2/checklist/assessment/import/add` registra uma avaliação com o modelo, a unidade, o criador, o responsável, a data agendada, as datas de início e de envio, o check-in e o check-out com geolocalização e as respostas de cada questão, pelo código da questão e das opções escolhidas ou pelo texto da resposta. A avaliação importada fica concluída (`CLOSED`), e a resposta traz o código dela. É a primeira escrita de Checklist na v2: o módulo passa a ter 10 endpoints, e a referência da v2, 45.
* **Categoria do modelo de checklist**: cada modelo da listagem de modelos traz `category`, com código, nome e se a categoria está ativa. O código é o mesmo do filtro `categoryId`.
* **Seção da questão nos planos de ação de checklist**: na listagem de planos de ação da v2, a questão da resposta de origem (`assessmentAnswer.question`) traz `secao`, com código e nome da seção. O nome do campo é em português, diferente do `section` dos demais endpoints de Checklist.
* **Código das opções das questões de checklist**: na listagem de questões do modelo da v2, cada opção de `typeSettings.option` traz `id`, o mesmo código que vem em `answerTemplateOptionId` nas respostas da avaliação.
### Observações para quem integra
* Em Checklist v2, a documentação passou a mostrar os campos que podem vir `null`: datas, `asset`, `campaign`, `earlyStartEnabled` e `scoreZeroed` da avaliação; data, comentário, navegador e geolocalização do check-in e do check-out; `scoreZeroed` das respostas; e `whenDate`, `whoUser`, `closedAt` e o objeto em avaliação do plano de ação. Trate esses campos como opcionais na sua integração.
* A origem dos anexos do modelo de checklist (`attachmentSource`) tem só dois valores, `CAMERA_ONLY` e `CAMERA_AND_UPLOAD`. O valor `CAMERA_AND_LIBRARY`, que a documentação listava, não existe.
## 2026-10-16
### Adicionado
* **Módulo de Checklist na API v2**: nove endpoints de leitura na base `/api/v2/checklist/`, para listar avaliações com filtros de situação, responsável, modelo e data agendada, as respostas de uma avaliação, o check-in e o check-out, os modelos de checklist com as seções e as questões, os planos de ação e a timeline de cada plano. É o quarto módulo da v2, ao lado de Compras, Comunicados e Chamados, e a referência da v2 passa a ter 44 endpoints. A v1 de Checklist continua em produção e documentada.
* **Dicionário de Checklist v2**: situação da avaliação e do plano de ação, tipos de questão, perfil do responsável, origem dos anexos e tipos de evento do plano de ação.
### Observações para quem integra
* Os códigos da v2 são de texto. A situação da avaliação vem em `status` (na v1, `situacao` numérico) e o tipo da questão em `type` (na v1, `tipo`).
* O check-in e o check-out respondem com um objeto único, não um array, apesar do `/list` no caminho.
* A pontuação da avaliação não vem enquanto ela está em aberto, e a das respostas não vem em avaliação agendada.
## 2026-10-14
**Nomes de campos de Compras v2 mudaram na documentação.** A resposta da listagem de pedidos passou a documentar `shippingMethod` e `shippingAddress` no lugar de `deliveryMethod` e `deliveryAddress`, e a de produtos do pedido documenta `price` no lugar de `unitPrice`. São os nomes que o portal oficial publica desde 14/08/2026. Se a sua integração lê os nomes antigos, confira a resposta real da API antes de trocar; a confirmação com a engenharia está pendente.
### Adicionado
* **Módulo de Chamados na API v2**: dez endpoints na base `/api/v2/chamados/`, para listar chamados com filtros de situação, direção e período, consultar a timeline, abrir, concluir com avaliação de satisfação, registrar interações, adicionar e remover apoios e etiquetas e alterar o prazo. É o terceiro módulo da v2, ao lado de Compras e Comunicados. A v1 de Chamados continua em produção e documentada.
* **Ativar e inativar produto na API v2**: `PUT /api/v2/compras/product/activate` e `PUT /api/v2/compras/product/inactivate`. Ao ser inativado, o produto sai dos carrinhos em que estiver. Compras passou de 20 para 22 endpoints documentados, e a referência da v2, para 35.
* **Dicionário de Chamados v2**: situação, direção e origem do chamado, e os tipos de evento da timeline.
* **Filtro `canceled` na listagem de pedidos da v2**: `canceled=true` traz só os pedidos cancelados e `false` (padrão), só os não cancelados. Cada pedido traz também o campo `canceled`, e o filtro `status` passou a aceitar `OPEN` e `CONCLUDED`.
* **Valores de desconto em Compras v2**: `productSubtotal` e `productDiscount` no pedido, `regularPrice` e `discount` nos produtos do pedido, e `regularPrice` (preço sem desconto) na listagem e na edição de preços.
* **Vídeos** nas páginas de Make, Zapier e de criação do token da v1, os mesmos do portal anterior.
### Alterado
* **Compras na v1 não recebe novas funcionalidades.** Etapas de pedido, mix de produtos e as novidades seguintes do módulo chegam só na v2. Integração nova de Compras deve usar a v2; a v1 de Compras segue funcionando e documentada.
### Observações para quem integra
* Sem o filtro `status`, a listagem de chamados traz só os chamados em aberto. Para incluir resolvidos e concluídos, informe `RESOLVED` e `CLOSED`, separados por vírgula.
* Os códigos da v2 são de texto. A situação vem em `status` (na v1, `situacao`) e a direção em `direction` (na v1, `tipo`). O campo `type` da v2 é outra coisa: a origem do chamado.
* Remover apoio e remover etiqueta usam `DELETE` com os dados na query string, não no corpo.
## 2026-08-27
### Adicionado
* **Módulo de Comunicados na API v2**: três endpoints na base `/api/v2/comunicado/`, para listar os comunicados publicados, acompanhar quem visualizou e aceitou cada um, e obter o conteúdo com anexos. É o segundo módulo da v2, ao lado de Compras, e a referência da versão passou a ter 23 endpoints.
* **Dicionário de Comunicados v2**: os perfis de visibilidade (`ADMIN` e `COMPANY`), os campos de estado do comunicado e os de leitura por pessoa.
### Observações para quem integra
* O endpoint de conteúdo (`announcement/content/list`) devolve **um objeto único, não um array, e não tem paginação**, diferente dos outros dois do módulo e do padrão da v2.
* As datas de publicação (`publishStartDate` e `publishEndDate`) usam `yyyy-MM-dd`, enquanto `createdAt` e `viewedAt` seguem UTC ISO 8601.
## 2026-08-24
### Adicionado
* **Dois endpoints do módulo de Compras na v2 passaram a ser documentados**: remover produto do mix (`DELETE /api/v2/compras/product-assortment/product/remove`) e cancelar pedido (`PUT /api/v2/compras/order/cancel`). Os dois já existiam na API, mas estavam fora da referência. O total documentado do módulo passou de 18 para 20.
* **Guia geral**: a documentação ganhou uma área para o conteúdo que vale para qualquer versão, com as páginas de conceito, limites, integrações sem código e recursos de IA.
### Alterado
* **A escolha de versão passou a ser explícita.** A entrada da documentação não abre mais com a v1 pré-selecionada. Agora você escolhe entre Guia geral, API v1 e API v2 no seletor superior, e cada área tem a sua própria navegação.
* **Conteúdo neutro saiu de dentro das versões.** As páginas de integrações sem código, recursos de IA e comparação entre versões estavam duplicadas na v1 e na v2 e agora vivem no Guia geral. As URLs antigas redirecionam para os novos endereços.
* **A referência da v2 agora mostra que é o módulo de Compras.** Os grupos Produtos, Mix de produtos e Pedidos e etapas ficavam soltos, sem indicar o módulo a que pertencem.
### Corrigido
* **A documentação afirmava que a v1 era somente leitura.** A v1 tem 7 endpoints de escrita em Chamados, Compras e Expansão. O que a engenharia confirmou é mais específico: não existe escrita de unidades e colaboradores.
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.