Documents

A query Documents retorna os documents de uma entidade, paginados por cursor, com no máximo 50 itens por página.

A paginação segue o padrão de conexões do Storefront API: os cursores (after/before) são a hash do document e a ordenação é crescente pelo identificador do document, ou seja, na ordem em que os documents foram criados.

A query também aceita filtros opcionais por identificador externo e por data de cadastro.

Parâmetros

*Informe first ou last — um dos dois é obrigatório.

Filtros

Os três filtros são opcionais e combinados entre si — e com os argumentos de paginação — por E (AND): o document precisa satisfazer todos os filtros informados para aparecer na página. Quando nenhum é enviado, a query se comporta exatamente como antes da introdução deles.

externalIds

Filtra pelo identificador que o document tem no sistema de origem da loja (externalId, definido na criação pela API Pública).

• Aceita até 50 valores por chamada. Acima disso, a query retorna o erro WDC106;
• Valores vazios ou compostos apenas de espaços em branco são descartados;
• Documents sem identificador externo nunca são retornados quando o filtro é informado;
• Um valor sem correspondência não é erro: ele simplesmente não traz resultado.

createdAt_gte e createdAt_lte

Delimitam a data de cadastro do document, interpretada em UTC e sempre inclusive. São strings — e não um escalar de data — justamente para preservar a diferença entre uma data pura e uma data com horário. São aceitos:

Campos de retorno

Exemplo

query {
  documents(entityName: "ficha-tecnica", first: 2) {
    edges {
      cursor
      node {
        id
        data
      }
    }
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
  }
}

{
  "data": {
    "documents": {
      "edges": [
        {
          "cursor": "eyJFbnRpdHkiOiJEb2N1bWVudFZhbHVlIiwiSWQiOjQ1MDF9",
          "node": {
            "id": "eyJFbnRpdHkiOiJEb2N1bWVudFZhbHVlIiwiSWQiOjQ1MDF9",
            "data": {
              "sku": "ABC-123",
              "cor": "Azul"
            }
          }
        },
        {
          "cursor": "eyJFbnRpdHkiOiJEb2N1bWVudFZhbHVlIiwiSWQiOjQ1MDJ9",
          "node": {
            "id": "eyJFbnRpdHkiOiJEb2N1bWVudFZhbHVlIiwiSWQiOjQ1MDJ9",
            "data": {
              "sku": "DEF-456",
              "cor": "Preto"
            }
          }
        }
      ],
      "pageInfo": {
        "hasNextPage": true,
        "hasPreviousPage": false,
        "startCursor": "eyJFbnRpdHkiOiJEb2N1bWVudFZhbHVlIiwiSWQiOjQ1MDF9",
        "endCursor": "eyJFbnRpdHkiOiJEb2N1bWVudFZhbHVlIiwiSWQiOjQ1MDJ9"
      }
    }
  }
}

Exemplo com after e fields

Para avançar para a próxima página, envie em after o endCursor da página anterior enquanto hasNextPage for true:

query {
  documents(
    entityName: "ficha-tecnica"
    first: 2
    after: "eyJFbnRpdHkiOiJEb2N1bWVudFZhbHVlIiwiSWQiOjQ1MDJ9"
    fields: ["sku", "custo"]
  ) {
    nodes {
      id
      data
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}

{
  "data": {
    "documents": {
      "nodes": [
        {
          "id": "eyJFbnRpdHkiOiJEb2N1bWVudFZhbHVlIiwiSWQiOjQ1MDN9",
          "data": {
            "sku": "GHI-789",
            "custo": null
          }
        }
      ],
      "pageInfo": {
        "hasNextPage": false,
        "endCursor": "eyJFbnRpdHkiOiJEb2N1bWVudFZhbHVlIiwiSWQiOjQ1MDN9"
      }
    }
  }
}

No exemplo acima, custo retorna null porque a propriedade não é pública (publicView: false) na entidade.

Exemplo com filtros

Documents cadastrados em agosto de 2026 cujo identificador externo seja ERP-0001 ou ERP-0003:

query {
  documents(
    entityName: "ficha-tecnica"
    first: 10
    externalIds: ["ERP-0001", "ERP-0003"]
    createdAt_gte: "2026-08-01"
    createdAt_lte: "2026-08-31"
  ) {
    nodes {
      id
      data
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}

{
  "data": {
    "documents": {
      "nodes": [
        {
          "id": "eyJFbnRpdHkiOiJEb2N1bWVudFZhbHVlIiwiSWQiOjQ1MDF9",
          "data": {
            "sku": "ABC-123",
            "cor": "Azul"
          }
        },
        {
          "id": "eyJFbnRpdHkiOiJEb2N1bWVudFZhbHVlIiwiSWQiOjQ1MDN9",
          "data": {
            "sku": "GHI-789",
            "cor": "Verde"
          }
        }
      ],
      "pageInfo": {
        "hasNextPage": false,
        "endCursor": "eyJFbnRpdHkiOiJEb2N1bWVudFZhbHVlIiwiSWQiOjQ1MDN9"
      }
    }
  }
}

Para pedir a página seguinte deste mesmo resultado, envie o endCursor em after e reenvie os três filtros.