Obter dados do catálogo
Em fluxos de trabalho que exigem dados do catálogo, é possível usar a ação Obter dados do catálogo para recuperar as informações do catálogo B2B da loja. Os Catálogos são grupos de produtos com preços personalizados para clientes B2B específicos ou locais da empresa.
Configuração
Campos
A ação Obter dados do catálogo contém os seguintes campos:
| Campo | Descrição |
|---|---|
| Classificar dados por | Obrigatório. Os parâmetros pelos quais os dados retornados pela consulta de pesquisa são classificados. |
| Número máximo de resultados | Obrigatório. A quantidade máxima de resultados que a consulta de pesquisa selecionada pode retornar. É possível retornar até 100 por vez. |
| Consulta | Obrigatório. Escolha entre as consultas comuns ou selecione Avançado para criar a sua. |
String de consulta
Este é um exemplo de consulta para obter todos os catálogos ativos:
status:ACTIVEA variável status é um filtro disponível na consulta de catálogos e pode ser usada várias vezes ou combinada a outras variáveis.
Ao consultar dados, é útil saber:
As consultas precisam seguir uma sintaxe específica
Os valores dos campos de consulta nem sempre estão documentados. Em alguns casos, é possível encontrar os valores na documentação da API. Outra opção costuma ser procurar esses valores nos URLs do admin quando você aplica filtros. Por exemplo, para encontrar alguns valores de consulta de pedidos, filtre a página Pedidos no admin e verifique o URL.
É possível executar ou testar uma consulta na loja usando o app Shopify GraphiQL.
Tenha cuidado com o que acontece se a consulta falhar. Muitas vezes, a API retorna todos os resultados (em vez de nenhum).
Dados retornados
Todas as ações de Obter dados retornam uma lista com algo entre 0 e 100 recursos. Dependendo do caso de uso, convém utilizar esses dados de várias maneiras:
- Se for necessário processar cada item da lista individualmente, como para adicionar uma tag a cada um, use a ação Para cada.
- Se for necessário agregar dados, como contar quantos resultados foram retornados, use as ações de Contagem ou de Soma.
- Se for preciso gerar a lista, como enviar um e-mail com todos os itens, use os dados retornados diretamente nas ações subsequentes.
Para acessar os dados retornados nas etapas seguintes a esta ação, use a variável chamada Get catalog data, que é uma lista de catálogos. É possível usar essa variável tanto em condições quanto em ações. Por exemplo, você pode enviar a lista de catálogos em uma ação Enviar e-mail interno semelhante a esta:
{% for single_catalog in getCatalogData %}
* {{ single_catalog.title }}
{% endfor %}Acionadores
É possível usar essa ação em qualquer fluxo de trabalho, incluindo o acionador Horário agendado. Em um fluxo de trabalho que usa o acionador Horário agendado, o fluxo de trabalho é iniciado em um horário especificado, e não como resultado de um evento. Como não há um evento específico na loja ou em um app que inicie o fluxo de trabalho, não há dados incluídos automaticamente.
Referência da API
Para saber mais sobre a API usada nesta ação, consulte a consulta de catálogos.