Obter dados da tentativa de faturamento da assinatura

Em workflows que exigem dados da tentativa de faturamento de assinatura, use a ação Obter dados da tentativa de faturamento da assinatura para recuperar informações de pedidos da loja.

Configuração

Campos

A ação Obter dados da tentativa de faturamento da assinatura contém os seguintes campos, usados para criar a consulta:

String de consulta

Este é um exemplo de consulta para obter tentativas de faturamento de assinatura 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 de assinatura e pode ser usada para selecionar mensagens de erro específicas para tentativas de faturamento de assinatura.

Ao consultar dados, é útil saber:

• Lista de filtros de tentativa de faturamento de assinatura 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 da tentativa de faturamento da assinatura, que é uma lista de tentativas de faturamento de assinatura. É possível usar essa variável em condições e ações. Por exemplo, você pode enviar a lista de tentativas de faturamento de assinatura em uma ação Enviar e-mail interno desta forma:

{% for getSubscriptionBillingAttemptData_item in getSubscriptionBillingAttemptData %}
  {{getSubscriptionBillingAttemptData_item.errorMessage}}
{% endfor %}

Exemplo

Por exemplo, um workflow está programado para ser executado todo domingo às 9h. A ação Obter dados da tentativa de faturamento da assinatura é usada para coletar dados de tentativas de faturamento de assinatura criadas na última semana. Se elas tiverem uma mensagem de erro, as tentativas de faturamento serão enviadas por e-mail.

Referência da API

• Recurso de tentativa de faturamento de assinatura
• Filtros de consulta de tentativa de faturamento de assinatura