Inserindo um document pelo nome da entidade

POST https://api.fbits.net/document/values/by-entity-name/{name}

Para criar um document identificando a entidade pelo nome, utilize o endpoint Cria um document pelo nome da entidade.

Nessa variação a entidade vem na rota, portanto apenas o document é enviado no corpo. É útil para integrações que conhecem o nome da entidade, mas não o seu identificador.

Parâmetros para criação:

  • name - nome da entidade (a busca não diferencia maiúsculas de minúsculas);
  • value - o document em JSON, com no máximo 2.000 caracteres, validado contra o schema da entidade;
  • externalId - identificador do document no sistema de origem da loja, com até 50 caracteres e único entre os documents ativos da entidade (opcional).

Request body:

{
  "value": "{\"sku\":\"ABC-123\",\"peso\":1.75}",
  "externalId": "ERP-0002"
}

Response body:

{
  "id": 4502,
  "documentEntityId": 12,
  "externalId": "ERP-0002",
  "value": "{\"sku\":\"ABC-123\",\"peso\":1.75}",
  "createdAt": "2026-07-27T16:31:12.000Z",
  "updatedAt": "2026-07-27T16:31:12.000Z"
}

O externalId segue as mesmas regras da criação por identificador da entidade: é opcional, tem os espaços das bordas removidos, aceita até 50 caracteres, é único entre os documents ativos da entidade resolvida pelo nome e é imutável depois de gravado.

🚧

Quando não existe entidade com o nome informado, o retorno é 404. O retorno é 400 quando o value está ausente, tem mais de 2.000 caracteres, não é um objeto JSON válido, não satisfaz o schema da entidade ou quando o externalId já aparado tem mais de 50 caracteres — incluindo o caso de propriedades não declaradas no schema quando a entidade está com allowAdditionalProperties: false, situação em que a mensagem traz o caminho da propriedade rejeitada (ex.: /cfg/extra).

🚧

O retorno é 409 quando já existe um document ativo com o mesmo externalId na entidade.