Inserindo um document

POST https://api.fbits.net/document/values

Para criar um document, utilize o endpoint Cria um document.

Parâmetros para criação:

    • documentEntityId - identificador da entidade à qual o document pertence. A entidade deve existir na loja;
    • value - o document em JSON, validado contra o schema da entidade. Pode conter propriedades não declaradas no schema quando a entidade estiver com allowAdditionalProperties: true.

Request body:

{
  "documentEntityId": 12,
  "value": "{\"sku\":\"ABC-123\",\"peso\":1.75}"
}

Response body:

{
  "id": 4501,
  "documentEntityId": 12,
  "value": "{\"sku\":\"ABC-123\",\"peso\":1.75}",
  "createdAt": "2026-07-27T16:20:00.000Z",
  "updatedAt": "2026-07-27T16:20:00.000Z"
}
🚧

O retorno é 400 quando o value está ausente, não é um objeto JSON válido, não satisfaz o schema da entidade ou quando a entidade informada em documentEntityId 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, /tags/0/extra).

📘

Quando a entidade está com allowAdditionalProperties: true, o value pode trazer propriedades que não estão no schema, em qualquer profundidade, e elas são gravadas junto ao document. Nas leituras autenticadas pela API Pública o document é sempre retornado completo, incluindo essas propriedades.