Atualizando um document específico

PUT https://api.fbits.net/document/values/{id}

Para atualizar um document, utilize o endpoint Atualiza um document.

Apenas o conteúdo do document é atualizado. A entidade do document e o seu externalId são definidos na criação e não podem ser alterados, por isso não são enviados no corpo.

Parâmetros para atualização:

- id - identificador do document;
- value - o document em JSON atualizado, com no máximo 2.000 caracteres, validado contra o schema da entidade. Pode conter propriedades não declaradas no schema quando a entidade estiver com allowAdditionalProperties: true.

Request body:

{
  "value": "{\"sku\":\"ABC-123\",\"peso\":2.1}"
}

Response body:

{
  "id": 4501,
  "documentEntityId": 12,
  "externalId": "ERP-0001",
  "value": "{\"sku\":\"ABC-123\",\"peso\":2.1}",
  "createdAt": "2026-07-27T16:20:00.000Z",
  "updatedAt": "2026-07-27T17:05:44.000Z"
}

📘
O externalId é imutável: o corpo do PUT não recebe o campo, e a atualização nunca altera nem anula o identificador gravado. A resposta continua devolvendo o valor persistido, como no exemplo acima.

🚧
O retorno é 400 quando o value tem mais de 2.000 caracteres, não é um objeto JSON válido ou não satisfaz o schema da entidade, e 404 quando o document não existe na loja. Se a entidade estiver com allowAdditionalProperties: false, propriedades não declaradas no schema também resultam em 400, com o caminho da propriedade rejeitada (ex.: /cfg/extra).

🚧
Documents gravados antes da introdução do limite de 2.000 caracteres continuam podendo ser lidos e removidos, mas falham na próxima atualização enquanto o value não for reduzido.

📘
Alterar allowAdditionalProperties na entidade não revalida os documents já gravados: a nova regra vale a partir das próximas criações e atualizações. Um document que já possui propriedades adicionais passa a ser rejeitado na próxima atualização caso a entidade tenha voltado para false.

Updated 13 days ago