Помощь
Войти

Предварительный просмотр данных API, используемых в Shopify Flow

Большинство рабочих процессов получают доступ к данным из вашего магазина, чтобы вы могли использовать их в условиях и действиях. Shopify Flow получает доступ к данным магазина, вызывая GraphQL Admin API, что даёт вам доступ почти ко всем полям в API.

При создании рабочего процесса вы часто будете встречать названия полей и описания на основе API, но вам может потребоваться узнать значения этих данных. Например, вам может понадобиться узнать название приложения для заказа, созданного из черновика заказа. Кроме того, вам может понадобиться убедиться, что рабочий процесс выводит данные в ожидаемом виде и формате.

В Shopify Flow есть несколько способов просмотреть значения данных.

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

Поиск поля в панели администратора Shopify

В большинстве случаев данные можно найти в панели администратора Shopify. Например, product.title указано на странице товара.

Получение образцов данных

При создании рабочего процесса вы можете получать образцы данных прямо в редакторе Flow. Данные для Flow поступают из событий, поэтому, чтобы получить точные образцы данных, необходимо сначала выбрать подходящее событие:

  1. В редакторе Flow откройте действие, в котором вы хотите использовать данные, и нажмите «Добавить переменную». Либо в условии нажмите «Добавить критерий».
  2. Нажмите «Настроить образцы данных».
  3. Flow отображает предыдущие события на основе триггера рабочего процесса. Нажмите «Обновить события», чтобы загрузить события из недавних запусков, или нажмите «Начать отслеживание событий в реальном времени», а затем вручную активируйте событие в админе или в соответствующем приложении (для триггеров на основе приложений).
  4. После того как событие произойдёт, Flow отобразит подробности о нём. Выберите событие, которое вы хотите использовать для получения образцов данных. Нажмите «Использовать это событие-триггер».
  5. Теперь при просмотре событий для каждой переменной должны отображаться образцы данных.

Ограничения:

  • Из-за нехватки места для данных в списке Flow будет отображать данные только первого элемента списка.
  • Flow хранит до 5 событий одновременно для каждого рабочего процесса.
  • Flow не может загружать события из недавних запусков для некоторых триггеров, таких как «Запланированное время», «Создана запись метаобъекта», «Клиент добавлен в сегмент» или «Клиент покинул сегмент».

Использование поля в активном рабочем процессе

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

Шаги для использования действия «Записать вывод»:

  1. Выберите триггер, который можно запустить вручную.
  2. Добавьте в рабочий процесс действие «Записать вывод» и свяжите его с триггером.
  3. В настройках действия «Записать вывод» нажмите «Добавить переменную», чтобы добавить переменные для проверки в раздел «Вывод».
  4. Когда закончите, нажмите «Включить рабочий процесс».
  5. Активируйте рабочий процесс, запустив его вручную или вызвав срабатывание триггера. Например, если вы используете триггер «Заказ создан», создайте тестовый заказ.
  6. После запуска рабочего процесса проверьте переменные в журнале активности.

Обращение к странице JSON ресурса

Большинство страниц ресурсов в панели администратора Shopify, например страницы заказа, товара или клиента, позволяют просматривать данные, на основе которых они формируются. Именование и формат этих данных не полностью совпадают с теми, что используются в Shopify Flow, но значения соответствуют данным в GraphQL Admin API. Чтобы просмотреть эти данные, добавьте .json в конец URL-адреса.

Например, перейдите к заказу, открыв в панели администратора Shopify страницу «Заказы» и выбрав нужный заказ. В адресной строке браузера измените адрес страницы с:

https://https://admin.shopify.com/store/<shopname>/orders/3804849891234

На следующий:

https://https://admin.shopify.com/store/<shopname>/orders/3804849891234.json

Использование GraphiQL или стороннего инструмента API

Вы можете напрямую отправлять запросы в API с помощью стороннего инструмента, такого как Postman, или бесплатного инструмента от Shopify — GraphiQL. Этот способ дает наиболее точные результаты, но требует некоторого знакомства с созданием запросов GraphQL.

Для работы с GraphiQL Shopify предлагает как веб-обозреватель GraphiQL с общими данными, так и приложение GraphiQL. С помощью GraphiQL вы можете создать запрос GraphQL, который будет в точности соответствовать названиям полей в Shopify Flow. При использовании приложения значения также будут в точности соответствовать данным вашего магазина.

С помощью этого инструмента вы можете точно определить, какие данные использует Shopify Flow, работая с реальными данными вашего магазина. Например, создайте следующий запрос:

{
  orders(first:5, reverse:true) {
    nodes {
      createdAt
      app {
        name
      }
      channelInformation {
        app {
          title
        }
      }
    }
  }
}

В следующих результатах переменная order / app / name отображает название приложения для заказа. В данном случае заказ был создан из приложения для черновиков заказов, поэтому значение — «Черновики заказов». Информация о канале доступна только для приложения «Точка продаж».

{
  "data": {
    "orders": {
      "nodes": [
        {
          "createdAt": "2023-04-10T12:32:41Z",
          "app": {
            "name": "Draft Orders"
          },
          "channelInformation": null
        },
        {
          "createdAt": "2023-04-10T12:29:12Z",
          "app": {
            "name": "Draft Orders"
          },
          "channelInformation": null
        },
        {
          "createdAt": "2023-03-17T20:23:10Z",
          "app": {
            "name": "Draft Orders"
          },
          "channelInformation": null
        },
        {
          "createdAt": "2023-03-17T20:20:53Z",
          "app": {
            "name": "Draft Orders"
          },
          "channelInformation": null
        },
        {
          "createdAt": "2023-03-17T15:45:15Z",
          "app": {
            "name": "Point of Sale"
          },
          "channelInformation": {
            "app": {
              "title": "Point of Sale"
            }
          }
        }
      ]
    }
  }