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, 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;
  • 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:

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

Response body:

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

Sobre o externalId

• É opcional: ausente, nulo ou composto apenas de espaços em branco é gravado como nulo, e vários documents sem externalId podem coexistir na mesma entidade;
• Os espaços das bordas são removidos antes de gravar (" 0001 " é gravado como "0001"), e o valor já aparado deve ter no máximo 50 caracteres;
• É único entre os documents ativos da mesma entidade. O mesmo valor pode ser usado em entidades diferentes, e o identificador de um document removido fica liberado para reuso;
• É imutável: definido apenas nesta criação e nunca alterado pelo PUT.