Coletar dados de tentativa de cobrança de assinatura
Nos fluxos de trabalho que exigem dados de tentativa de faturamento de assinatura, use a ação Coletar dados de tentativa de cobrança de assinatura para recuperar as informações do pedido da loja.
Nesta página
Configuração
Campos
A ação Coletar dados de tentativa de cobrança 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
Este é um exemplo de consulta para obter tentativas de faturamento de assinatura que foram criadas nos últimos três dias:
created_at:>'{{ createdAt | date_minus: "3 day" }}'A variável created_at é um filtro disponível na consulta de tentativa de faturamento da assinatura e pode ser usada para selecionar uma mensagem de erro específica para tentativas de faturamento da assinatura.
Quando consultar dados, é útil conhecer:
- Lista de filtros de tentativas de faturamento de assinatura 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 Coletar dados de tentativa de cobrança de assinatura, que é uma lista de tentativas de cobrança de assinatura. Essa variável pode ser usada em condições e em ações. Por exemplo, você pode enviar a lista de tentativas de cobrança de assinatura em uma ação Enviar e-mail interno como esta:
{% for getSubscriptionBillingAttemptData_item in getSubscriptionBillingAttemptData %}
{{getSubscriptionBillingAttemptData_item.errorMessage}}
{% endfor %}Exemplo
Por exemplo, um fluxo de trabalho é agendado para ser executado todos os domingos, às 9h. A ação Coletar dados de tentativa de cobrança de assinatura é usada para coletar dados de tentativas de faturamento de assinatura criadas na última semana. Se elas apresentam uma mensagem de erro, um e-mail é enviado com as tentativas de faturamento.