Obter dados do contrato de assinatura

Em workflows que usam dados de contrato de assinatura, é possível usar a ação Obter dados do contrato de assinatura para recuperar informações de contrato de assinatura da loja.

Nesta página

Configuração

Campos

A ação Obter dados do contrato de assinatura contém os seguintes campos, que são usados para criar a consulta:

Campos usados nas ações Obter dados.
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 podem ser retornados pela consulta de pesquisa selecionada. É possível retornar até 100 por vez.
Consulta	Obrigatório. Escolha entre as consultas comuns ou selecione Avançado para criar uma consulta própria.

String de consulta

Este é um exemplo de consulta para obter contratos de assinatura com status ACTIVE:

status: ACTIVE

A variável status é um filtro disponível na consulta de Contratos de assinatura e pode ser usada várias vezes.

Ao consultar dados, é útil saber o seguinte:

Lista de filtros disponíveis
As consultas devem seguir uma sintaxe específica
Os valores dos campos de consulta nem sempre são documentados. Em alguns casos, os valores podem ser encontrados na documentação da API. Como alternativa, muitas vezes é possível encontrar os valores dos campos nos URLs do painel do admin quando se aplica um filtro. Por exemplo, para encontrar alguns valores de consulta de Pedido, filtre a página Pedidos no painel do admin e verifique o URL.
É possível executar ou testar uma consulta na loja usando o app Shopify GraphiQL.
Fique atento ao que acontece se a consulta falhar. Muitas vezes, a API retorna todos os resultados (em vez de nenhum).

Dados retornados

Todas as ações Obter dados retornam uma lista de 0 a 100 recursos. Dependendo do caso de uso, é possível usar esses dados de várias maneiras:

Se for preciso processar cada item da lista individualmente, por exemplo, para adicionar uma tag a cada um, use a ação Para cada.
Se for preciso agregar dados, como contar quantos resultados foram retornados, use as ações Contar ou Somar.
Se for preciso usar a lista como resultado, por exemplo, para enviar um e-mail com todos os itens, os dados retornados poderão ser usados diretamente em ações subsequentes.

Para acessar os dados retornados nas etapas seguintes a essa ação, use a variável chamada Obter dados do contrato de assinatura, que é uma lista de contratos de assinatura. É possível usar essa variável em condições e ações. Por exemplo, é possível enviar a lista de pedidos em uma ação Enviar e-mail interno desta forma:

{% for single_contract in GetSubscriptionContractData %}
* {{ single_contract.name }}
{% endfor %}

Acionadores

Esta ação pode ser usada em qualquer workflow, inclusive com o acionador Horário agendado. Nesse caso, o workflow começa em um horário predefinido por você, e não em resposta a um evento. Como nenhum evento da loja ou de um app inicia o workflow, nenhum dado é incluído automaticamente.