Помощь
Войти

Получить данные о попытках списания по подписке

В рабочих процессах, для которых требуются данные о попытках списания по подписке, вы можете использовать действие «Получить данные о попытках списания по подписке», чтобы получить информацию о заказах из вашего магазина.

На этой странице

Конфигурация

Поля

Действие «Получить данные о попытках списания по подписке» содержит следующие поля, которые используются для составления запроса:

Поля, используемые в действиях получения данных.
ПолеОписание
Сортировать данные поОбязательно. Параметры, по которым сортируются данные, возвращаемые поисковым запросом.
Максимальное количество результатовОбязательно. Максимальное количество результатов, которое может вернуть выбранный вами поисковый запрос. За один раз можно вернуть до 100 результатов.
ЗапросОбязательно. Выберите один из стандартных запросов или вариант «Дополнительно», чтобы создать собственный.

Строка запроса

Пример запроса для получения данных о попытках списания по подписке, созданных за последние три дня:

created_at:>'{{ createdAt | date_minus: "3 day" }}'

Переменная created_at — это фильтр, доступный в запросе о попытках списания по подписке, который можно использовать для выбора определённого сообщения об ошибке для попыток списания по подписке.

При составлении запросов полезно знать следующее:

  • Список доступных фильтров для попыток списания по подписке
  • Запросы должны соответствовать определённому синтаксису
  • Значения полей запроса документируются не всегда. В некоторых случаях их можно найти в документации по API. Кроме того, значения полей часто можно найти в URL-адресах в панели администратора при использовании фильтров. Например, чтобы найти значения для запроса заказов, отфильтруйте страницу «Заказы» в панели администратора, а затем проверьте URL-адрес.
  • Вы можете запустить или протестировать запрос в своём магазине с помощью приложения Shopify GraphiQL.
  • Помните о том, что произойдёт, если ваш запрос не будет выполнен. Часто API возвращает все результаты, а не ничего.

Возвращаемые данные

Все действия «Получить данные» возвращают список, содержащий от 0 до 100 ресурсов. В зависимости от вашего варианта использования эти данные можно применять по-разному:

  • Если вам нужно обрабатывать каждый элемент списка по отдельности, например добавлять тег к каждому из них, вы можете использовать действие «Для каждого».
  • Если вам нужно агрегировать данные, например подсчитать количество возвращённых результатов, вы можете использовать действия «Количество» или «Сумма».
  • Если вам нужно вывести список, например отправить электронное письмо со всеми элементами, вы можете использовать возвращённые данные непосредственно в последующих действиях.

Чтобы получить доступ к возвращённым данным на следующих шагах после этого действия, используйте переменную «Получить данные о попытках списания по подписке», которая представляет собой список попыток списания по подписке. Эту переменную можно использовать как в условиях, так и в действиях. Например, можно отправить список попыток списания по подписке с помощью действия «Отправить внутреннее электронное письмо» следующим образом:

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

Пример

Например, для рабочего процесса запланирован запуск каждое воскресенье в 9:00. Действие «Получить данные о попытках списания по подписке» используется для сбора данных о попытках списания по подписке, созданных за последнюю неделю. Если они содержат сообщение об ошибке, информация о таких попытках отправляется по электронной почте.

Справочник по API