Довідка
Увійти

Отримати дані про контракт на передплату

У робочих процесах, які використовують дані про контракти на передплату, ви можете використовувати дію Отримати дані про контракт на передплату, щоб отримувати інформацію про контракти на передплату з вашого магазину.

На цій сторінці

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

Поля

Дія Отримати дані про контракт на передплату містить такі поля, які використовуються для створення запиту:

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

Рядок запиту

Це приклад запиту для отримання контрактів на передплату зі статусом ACTIVE:

status: ACTIVE

Змінна status — це фільтр, доступний у запиті про контракти на передплату, який можна використовувати кілька разів.

Під час запиту даних корисно знати таке:

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

Повернуті дані

Усі дії Отримати дані повертають список, що містить від 0 до 100 ресурсів. Залежно від варіанта використання ви можете працювати з цими даними по-різному:

  • Якщо вам потрібно опрацювати кожну одиницю списку окремо, наприклад додати тег для кожної з них, ви можете скористатися дією Для кожного.
  • Якщо вам потрібно звести дані, наприклад порахувати кількість повернутих результатів, ви можете скористатися діями Кількість або Сума.
  • Якщо вам потрібно вивести список (наприклад, надіслати електронний лист з усіма одиницями), ви можете використати повернуті дані безпосередньо в наступних діях.

Щоб отримати доступ до повернутих даних у наступних кроках, використовуйте змінну Отримати дані про контракт на передплату — список контрактів на передплату. Ви можете використовувати цю змінну як в умовах, так і в діях. Наприклад, ви можете надіслати список замовлень через дію Надіслати внутрішній електронний лист у такий спосіб:

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

Тригери

Ви можете використовувати цю дію в будь-якому робочому процесі, зокрема з тригером Запланований час. У робочому процесі, що використовує тригер Запланований час, запуск відбувається в зазначений вами час, а не в результаті події. Оскільки немає конкретної події в магазині або із застосунку, яка б запускала робочий процес, жодні дані не додаються автоматично.

Довідка щодо API