documentCreate

A mutation DocumentCreate permite criar um document em uma entidade, identificada pelo nome.

O document é validado contra o schema da entidade antes de ser gravado. A operação exige que a entidade declare CREATE em publicOperations.

Parâmetros

Campos de retorno

Os campos de retorno são os do document criado.

Exemplo

mutation {
  documentCreate(
    entityName: "ficha-tecnica"
    value: { sku: "ABC-123", cor: "Azul", custo: 42.5 }
  ) {
    id
    data
  }
}

{
  "data": {
    "documentCreate": {
      "id": "eyJFbnRpdHkiOiJEb2N1bWVudFZhbHVlIiwiSWQiOjQ1MDF9",
      "data": {
        "sku": "ABC-123",
        "cor": "Azul"
      }
    }
  }
}

O document é gravado por completo, inclusive os campos não públicos, mas o retorno traz somente os campos com publicView: true — no exemplo, custo é gravado e omitido na resposta.

🚧

Limite de tamanho

O document é limitado a 2.000 caracteres de JSON. O limite é verificado antes da validação contra o schema: um document acima dele retorna WDC101 informando o tamanho, com o motivo na extensão detail.

📘

O identificador externo (externalId) não é definido por esta mutation

O externalId de um document — usado como filtro na query Documents — é informado apenas na criação pela API Pública, em Inserindo um document. Documents criados pelo Storefront API ficam sem identificador externo e, por isso, não são retornados quando o filtro externalIds é informado.