Помощь
Войти

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

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

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

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

Поля

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

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

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

Ниже приведён пример запроса для получения договоров на подписку со статусом ACTIVE:

status: ACTIVE

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

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

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

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

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

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

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

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

Триггеры

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

Справочник API