Get subscription contract data ("Coletar dados do contrato de assinatura")
Nos fluxos de trabalho que usam dados de contrato de assinatura, use a ação Get subscription contract data ("Coletar dados do contrato de assinatura") para recuperar as informações do contrato de assinatura da loja.
Nesta página
Configuração
Campos
A ação Get subscription contract data ("Coletar dados do contrato de assinatura") contém estes campos, que são usados para criar a consulta:
| Campo | Descrição |
|---|---|
| Ordenar dados por | Obrigatório. Os parâmetros que ordenam os dados retornados na consulta de pesquisa. |
| Número máximo de resultados | Obrigatório. Valor máximo de resultados retornados pela consulta de pesquisa selecionada. É possível retornar até 100 de cada vez. |
| Consulta | Obrigatório. Escolha uma das consultas comuns ou selecione Advanced ("Avançado") para criar a sua. |
String da consulta
Confira um exemplo de consulta para ver contratos de assinatura com o status ACTIVE:
status: ACTIVEA variável status é um filtro disponível na consulta Contratos de assinatura e pode ser usada várias vezes.
Quando consultar dados, é útil conhecer:
- Lista de filtros disponíveis - As consultas precisam seguir uma determinada sintaxe.
- Os nomes de campo de todas as consultas podem ser encontrados na documentação para desenvolvedores do objeto QueryRoot.
- Nem sempre os valores do campo de consulta estão documentados. Em alguns casos, eles podem ser encontrados na documentação da API. Também é possível encontrar com filtros os valores de campo nos URLs do admin. Por exemplo, para ver alguns valores da consulta de pedido, filtre a página "Pedidos" no admin e verifique o URL.
- É possível usar o app GraphiQL da Shopify para executar ou testar uma consulta na loja.
- Esteja ciente de que, se a consulta falhar, a API muitas vezes retornará todos os resultados, em vez de nenhum.
Dados retornados
Todas as ações Geta data ("Coletar dados") retornam uma lista com 0 a 100 recursos. Conforme o caso de uso, é possível usar esses dados de várias maneiras:
- Se for necessário lidar com cada item de lista individualmente, por exemplo, para adicionar uma tag, use a ação For each ("Para cada").
- Se for necessário agregar dados, como contar quantos resultados foram retornados, use as ações Count ("Contar") ou Sum ("Somar").
- Se for necessário gerar uma lista, por exemplo, para 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ção, use a variável denominada Get subscription contact data ("Coletar dados do contrato de assinatura"), que é uma lista de contratos de assinatura. Essa variável pode ser usada em condições e em ações. Por exemplo, é possível enviar a lista de pedidos em uma ação Send internal email ("Enviar e-mail interno") como esta:
{% for single_contract in GetSubscriptionContractData %}
- {{ single_contract.name }}
{% endfor %}Acionadores
Essa ação pode ser usada em todos os fluxos de trabalho, incluindo o acionador Scheduled time ("Horário agendado"). Os fluxos de trabalho com esse acionador se iniciam no momento que você especificou, não como resultado de um evento. Como não há nenhum evento específico na loja ou de um app que inicie o fluxo de trabalho, não há dados incluídos de forma automática.