Поделиться через

ConvertKit (независимый издатель)

ConvertKit — это go-to маркетинговый центр для создателей, который помогает вам расти и монетизировать аудиторию с легкостью. Преобразуйте подписчиков из социальных сетей, YouTube и многое другое в свой список электронной почты с красивой целевой страницей и шаблонами согласия.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга Class Регионы
Copilot Studio Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Логические приложения Стандарт Все регионы Logic Apps , кроме следующих:
     — Регионы Azure для государственных организаций
     — Регионы Azure Для Китая
     - Министерство обороны США (DoD)
Power Apps Премия Все регионы Power Apps , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Power Automate Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Контакт
Имя Трой Тейлор
URL https://www.hitachisolutions.com
Адрес электронной почты ttaylor@hitachisolutions.com
Метаданные соединителя
Publisher Трой Тейлор, Решения Похасти
Веб-сайт https://convertkit.com/
Политика конфиденциальности https://convertkit.com/privacy
Категории Маркетинг

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:
По умолчанию Параметры для создания подключения. Все регионы Недоступен для совместного использования

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя Тип Description Обязательно
Секрет API securestring Секрет API для этого API True

Ограничения регулирования

Имя Вызовы Период обновления
Вызовы API для каждого подключения 100 60 секунд

Действия

Вывод списка подписок на последовательность

Извлекает подписки в последовательность, включая данные подписчика.
Вывод списка подписок на тег

Извлекает список подписок на тег, включая данные подписчика.
Вывод списка подписок на форму

Извлекает список подписок в форму, включая данные подписчика.
Вывод списка подписчиков

Возвращает список подписчиков. Только для отмены подписок используйте отмененное значение для параметра поля сортировки (в настоящее время единственное поддерживаемое поле дополнительной сортировки).
Вывод списка тегов подписчика

Извлекает список всех тегов для подписчика.
Добавление подписчика в последовательность

Подписывайтесь на адрес электронной почты в одну из последовательностей.
Добавление подписчика в форму

Подпишитесь на адрес электронной почты в одну из форм.
Обновление подписчика

Обновляет сведения для одного подписчика.
Обновление трансляции

Обновляет атрибуты определенной широковещательной трансляции. Трансляции, отправляемые в настоящее время или отправленные, могут быть не обновлены.
Отмена подписки подписчика

Отмена подписки подписчика из всех форм и последовательностей.
Перечисление покупок

Получение списка всех покупок для учетной записи.
Перечисление последовательностей

Извлекает список последовательностей для учетной записи.
Получение подписчика

Извлекает одну запись подписчика.
Получение покупки

Получение определенной покупки по идентификатору.
Получение статистики трансляции

Извлекает статистику (число получателей, открытую частоту, скорость щелчка мыши, количество отмены подписки, общее количество щелчков, состояние и ход отправки) для определенной трансляции.
Получение трансляции

Извлекает сведения о определенной трансляции, включая черновик, запланированные и ранее отправленные трансляции.
Получение учетной записи

Извлекает текущую учетную запись.
Получение форм

Получение списка всех форм для учетной записи.
Создание покупки

Создайте покупку.
Создание тега

Создает новый тег.
Создание трансляции

Создайте черновик или запланированную трансляцию. Вы можете создать черновик трансляции без каких-либо атрибутов. Запланированные трансляции должны содержать строку темы и содержимое.
Список широковещательных трансляций

Извлекает список всех трансляций для вашей учетной записи.
Тег подписчика

Теги обрабатываются как подписки. Подпишите адрес электронной почты на тег, чтобы этот тег был применен к подписчику с помощью этого адреса электронной почты.
Теги списка

Извлекает список тегов для учетной записи.
Удаление тега из подписчика

Удаляет тег из подписчика.
Удаление тега из подписчика по электронной почте

Удалите тег из подписчика по адресу электронной почты.
Уничтожение трансляции

Окончательно удалите черновик или запланированную запись трансляции. Трансляции, отправляемые в настоящее время или отправленные, могут быть удалены.

Вывод списка подписок на последовательность

Идентификатор операции:
SequenceSubList

Извлекает подписки в последовательность, включая данные подписчика.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор последовательности
 sequence_id True string

Уникальный идентификатор последовательности.
Порядок сортировки
 sort_order string

Порядок сортировки.
Состояние подписчика
 subscriber_state string

Состояние подписчика.
Страница
 page integer

Страница.

Возвращаемое значение

Имя Путь Тип Описание
Всего подписок
 total_subscriptions integer

Общее количество подписок.
Страница
 page integer

Страница.
Всего страниц
 total_pages integer

Общие страницы.
Подписки
 subscriptions array of object
Идентификатор
 subscriptions.id integer

Уникальный идентификатор.
Государство
 subscriptions.state string

Государство.
Создано в
 subscriptions.created_at string

При создании.
Исходный материал
 subscriptions.source string

Источник.
Источник перехода
 subscriptions.referrer string

Ссылщик.
Идентификатор подписки
 subscriptions.subscribable_id integer

Подписываемый уникальный идентификатор.
Тип подписки
 subscriptions.subscribable_type string

Тип подписки.
Идентификатор
 subscriptions.subscriber.id integer

Уникальный идентификатор.
Имя (Первое имя)
 subscriptions.subscriber.first_name string

Первое имя.
Электронная почта
 subscriptions.subscriber.email_address string

Адрес электронной почты.
Государство
 subscriptions.subscriber.state string

Государство.
Создано в
 subscriptions.subscriber.created_at string

При создании.
Фамилия
 subscriptions.subscriber.fields.last_name string

Фамилия.

Вывод списка подписок на тег

Идентификатор операции:
TagSubList

Извлекает список подписок на тег, включая данные подписчика.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор тега
 tag_id True string

Уникальный идентификатор тега.
Порядок сортировки
 sort_order string

Порядок сортировки.
Состояние подписчика
 subscriber_state string

Состояние подписчика.
Страница
 page integer

Страница.

Возвращаемое значение

Имя Путь Тип Описание
Всего подписок
 total_subscriptions integer

Общее количество подписок.
Страница
 page integer

Страница.
Всего страниц
 total_pages integer

Общие страницы.
Подписки
 subscriptions array of object
Идентификатор
 subscriptions.id integer

Уникальный идентификатор.
Государство
 subscriptions.state string

Государство.
Создано в
 subscriptions.created_at string

При создании.
Исходный материал
 subscriptions.source string

Источник.
Источник перехода
 subscriptions.referrer string

Ссылщик.
Идентификатор подписки
 subscriptions.subscribable_id integer

Подписываемый уникальный идентификатор.
Тип подписки
 subscriptions.subscribable_type string

Тип подписки.
Идентификатор
 subscriptions.subscriber.id integer

Уникальный идентификатор.
Имя (Первое имя)
 subscriptions.subscriber.first_name string

Первое имя.
Электронная почта
 subscriptions.subscriber.email_address string

Адрес электронной почты.
Государство
 subscriptions.subscriber.state string

Государство.
Создано в
 subscriptions.subscriber.created_at string

При создании.
Фамилия
 subscriptions.subscriber.fields.last_name string

Фамилия.

Вывод списка подписок на форму

Идентификатор операции:
FormSubList

Извлекает список подписок в форму, включая данные подписчика.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор формы
 form_id True string

Уникальный идентификатор формы.
Порядок сортировки
 sort_order string

Порядок сортировки.
Состояние подписчика
 subscriber_state string

Состояние подписчика.
Страница
 page integer

Страница.

Возвращаемое значение

Имя Путь Тип Описание
Всего подписок
 total_subscriptions integer

Общее количество подписок.
Страница
 page integer

Страница.
Всего страниц
 total_pages integer

Общие страницы.
Подписки
 subscriptions array of object
Идентификатор
 subscriptions.id integer

Уникальный идентификатор.
Государство
 subscriptions.state string

Государство.
Создано в
 subscriptions.created_at string

При создании.
Исходный материал
 subscriptions.source string

Источник.
Источник перехода
 subscriptions.referrer string

Ссылщик.
Идентификатор подписки
 subscriptions.subscribable_id integer

Подписываемый уникальный идентификатор.
Тип подписки
 subscriptions.subscribable_type string

Тип подписки.
Идентификатор
 subscriptions.subscriber.id integer

Уникальный идентификатор.
Имя (Первое имя)
 subscriptions.subscriber.first_name string

Первое имя.
Электронная почта
 subscriptions.subscriber.email_address string

Адрес электронной почты.
Государство
 subscriptions.subscriber.state string

Государство.
Создано в
 subscriptions.subscriber.created_at string

При создании.
Фамилия
 subscriptions.subscriber.fields.last_name string

Фамилия.

Вывод списка подписчиков

Идентификатор операции:
SubscriberList

Возвращает список подписчиков. Только для отмены подписок используйте отмененное значение для параметра поля сортировки (в настоящее время единственное поддерживаемое поле дополнительной сортировки).

Параметры

Имя Ключ Обязательно Тип Описание
От
 from string

От.
Кому
 to string

На.
Обновлено из
 updated_from string

При обновлении из.
Обновлено до
 updated_to string

При обновлении до.
Порядок сортировки
 sort_order string

Порядок сортировки.
Поле сортировки
 sort_field string

Поле сортировки.
Электронная почта
 email_address string

Адрес электронной почты.
Страница
 page integer

Страница.

Возвращаемое значение

Имя Путь Тип Описание
Всего подписчиков
 total_subscribers integer

Общее число подписчиков.
Страница
 page integer

Страница.
Всего страниц
 total_pages integer

Общие страницы.
Подписчики
 subscribers array of object
Идентификатор
 subscribers.id integer

Уникальный идентификатор.
Имя (Первое имя)
 subscribers.first_name string

Первое имя.
Электронная почта
 subscribers.email_address string

Адрес электронной почты.
Государство
 subscribers.state string

Государство.
Создано в
 subscribers.created_at string

При создании.
Фамилия
 subscribers.fields.last_name string

Фамилия.

Вывод списка тегов подписчика

Идентификатор операции:
SubscriberTags

Извлекает список всех тегов для подписчика.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор подписчика
 subscriber_id True string

Уникальный идентификатор подписчика.

Возвращаемое значение

Имя Путь Тип Описание
Метки
 tags array of object
Идентификатор
 tags.id integer

Уникальный идентификатор.
Имя
 tags.name string

Имя.
Создано в
 tags.created_at string

При создании.

Добавление подписчика в последовательность

Идентификатор операции:
SequenceSubAdd

Подписывайтесь на адрес электронной почты в одну из последовательностей.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор последовательности
 sequence_id True string

Уникальный идентификатор последовательности.
Адрес электронной почты
 email True string

Адрес электронной почты.
Имя (Первое имя)
 first_name string

Первое имя.
Метки
 tags array of integer

Возвращаемое значение

Имя Путь Тип Описание
Идентификатор
 subscription.id integer

Уникальный идентификатор.
Государство
 subscription.state string

Государство.
Создано в
 subscription.created_at string

При создании.
Исходный материал
 subscription.source string

Источник.
Источник перехода
 subscription.referrer string

Ссылщик.
Идентификатор подписки
 subscription.subscribable_id integer

Подписываемый уникальный идентификатор.
Тип подписки
 subscription.subscribable_type string

Тип подписки.
Идентификатор
 subscription.subscriber.id integer

Уникальный идентификатор.

Добавление подписчика в форму

Идентификатор операции:
FormSubAdd

Подпишитесь на адрес электронной почты в одну из форм.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор формы
 form_id True string

Уникальный идентификатор формы.
Адрес электронной почты
 email True string

Адрес электронной почты.
Имя (Первое имя)
 first_name string

Первое имя.
Метки
 tags array of integer

Возвращаемое значение

Имя Путь Тип Описание
Идентификатор
 subscription.id integer

Уникальный идентификатор.
Государство
 subscription.state string

Государство.
Создано в
 subscription.created_at string

При создании.
Исходный материал
 subscription.source string

Источник.
Источник перехода
 subscription.referrer string

Ссылщик.
Идентификатор подписки
 subscription.subscribable_id integer

Подписываемый уникальный идентификатор.
Тип подписки
 subscription.subscribable_type string

Тип подписки.
Идентификатор
 subscription.subscriber.id integer

Уникальный идентификатор.
Имя (Первое имя)
 subscription.subscriber.first_name string

Первое имя.
Электронная почта
 subscription.subscriber.email_address string

Адрес электронной почты.
Государство
 subscription.subscriber.state string

Государство.
Создано в
 subscription.subscriber.created_at string

При создании.

Обновление подписчика

Идентификатор операции:
SubscriberUpdate

Обновляет сведения для одного подписчика.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор подписчика
 subscriber_id True string

Уникальный идентификатор подписчика.
Имя (Первое имя)
 first_name string

Первое имя.
Электронная почта
 email_address string

Адрес электронной почты.

Возвращаемое значение

Имя Путь Тип Описание
Идентификатор
 subscriber.id integer

Уникальный идентификатор.
Имя (Первое имя)
 subscriber.first_name string

Первое имя.
Электронная почта
 subscriber.email_address string

Адрес электронной почты.
Государство
 subscriber.state string

Государство.
Создано в
 subscriber.created_at string

При создании.

Обновление трансляции

Идентификатор операции:
BroadcastUpdate

Обновляет атрибуты определенной широковещательной трансляции. Трансляции, отправляемые в настоящее время или отправленные, могут быть не обновлены.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор трансляции
 broadcast_id True string

Уникальный идентификатор трансляции.
Description
 description string

Описание.
Тема
 subject string

Тема.
Content
 content string

Содержимое.
Электронная почта
 email_address string

Адрес электронной почты.
Шаблон макета электронной почты
 email_layout_template string

Шаблон макета электронной почты.
Публика
 public boolean

Является ли общедоступным.
Опубликовано в
 published_at string

При публикации на сайте.
Отправка по адресу
 send_at string

При отправке.
Замещающий эскиз
 thumbnail_alt string

Замещающий текст эскиза.
URL-адрес эскиза
 thumbnail_url string

URL-адрес эскиза.

Возвращаемое значение

Имя Путь Тип Описание
Идентификатор
 broadcast.id integer

Уникальный идентификатор.
Создано в
 broadcast.created_at string

При создании.
Тема
 broadcast.subject string

Тема.
Description
 broadcast.description string

Описание.
Content
 broadcast.content string

Содержимое.
Публика
 broadcast.public boolean

Является ли общедоступным.
Опубликовано в
 broadcast.published_at string

При публикации на сайте.
Отправка по адресу
 broadcast.send_at string

При отправке.
Замещающий эскиз
 broadcast.thumbnail_alt string

Замещающий текст эскиза.
URL-адрес эскиза
 broadcast.thumbnail_url string

URL-адрес эскиза.
Электронная почта
 broadcast.email_address string

Адрес электронной почты.
Шаблон макета электронной почты
 broadcast.email_layout_template string

Шаблон макета электронной почты.

Отмена подписки подписчика

Идентификатор операции:
SubscriberUnsub

Отмена подписки подписчика из всех форм и последовательностей.

Параметры

Имя Ключ Обязательно Тип Описание
Адрес электронной почты
 email True string

Адрес электронной почты.

Возвращаемое значение

Имя Путь Тип Описание
Идентификатор
 subscriber.id integer

Уникальный идентификатор.
Имя (Первое имя)
 subscriber.first_name string

Первое имя.
Электронная почта
 subscriber.email_address string

Адрес электронной почты.
Государство
 subscriber.state string

Государство.
Создано в
 subscriber.created_at string

При создании.
Фамилия
 subscriber.fields.last_name string

Фамилия.

Перечисление покупок

Идентификатор операции:
PurchaseList

Получение списка всех покупок для учетной записи.

Параметры

Имя Ключ Обязательно Тип Описание
Страница
 page integer

Страница.

Возвращаемое значение

Имя Путь Тип Описание
Всего покупок
 total_purchases integer

Общее количество покупок.
Страница
 page integer

Страница.
Всего страниц
 total_pages integer

Общие страницы.
Покупки
 purchases array of object
Идентификатор
 purchases.id integer

Уникальный идентификатор.
Код проводки
 purchases.transaction_id string

Уникальный идентификатор транзакции.
Состояние
 purchases.status string

Состояние.
Электронная почта
 purchases.email_address string

Адрес электронной почты.
Валюта
 purchases.currency string

Валюта.
Время транзакции
 purchases.transaction_time string

Время транзакции.
Промежуточный итог
 purchases.subtotal integer

Промежуточный итог.
Судоходство
 purchases.shipping integer

Доставка.
Скидка
 purchases.discount integer

Скидка.
Налоги
 purchases.tax integer

Налог.
Total
 purchases.total integer

Общее число.
Products
 purchases.products array of object
Цена за единицу
 purchases.products.unit_price integer

Цена за единицу.
Количество
 purchases.products.quantity integer

Количество.
Артикул (SKU)
 purchases.products.sku string

Номер SKU.
Имя
 purchases.products.name string

Имя.

Перечисление последовательностей

Идентификатор операции:
SequenceList

Извлекает список последовательностей для учетной записи.

Возвращаемое значение

Имя Путь Тип Описание
Курсы
 courses array of object
Идентификатор
 courses.id integer

Уникальный идентификатор.
Имя
 courses.name string

Имя.
Создано в
 courses.created_at string

При создании.

Получение подписчика

Идентификатор операции:
SubscriberGet

Извлекает одну запись подписчика.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор подписчика
 subscriber_id True string

Уникальный идентификатор подписчика.

Возвращаемое значение

Имя Путь Тип Описание
Идентификатор
 subscriber.id integer

Уникальный идентификатор.
Имя (Первое имя)
 subscriber.first_name string

Первое имя.
Электронная почта
 subscriber.email_address string

Адрес электронной почты.
Государство
 subscriber.state string

Государство.
Создано в
 subscriber.created_at string

При создании.
Фамилия
 subscriber.fields.last_name string

Фамилия.

Получение покупки

Идентификатор операции:
PurchaseGet

Получение определенной покупки по идентификатору.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор покупки
 purchase_id True string

Идентификатор покупки.

Возвращаемое значение

Имя Путь Тип Описание
Идентификатор
 id integer

Уникальный идентификатор.
Код проводки
 transaction_id string

Уникальный идентификатор транзакции.
Состояние
 status string

Состояние.
Электронная почта
 email_address string

Адрес электронной почты.
Валюта
 currency string

Валюта.
Время транзакции
 transaction_time string

Время транзакции.
Промежуточный итог
 subtotal integer

Промежуточный итог.
Судоходство
 shipping integer

Доставка.
Скидка
 discount integer

Скидка.
Налоги
 tax integer

Налог.
Total
 total integer

Общее число.
Products
 products array of object
Цена за единицу
 products.unit_price integer

Цена за единицу.
Количество
 products.quantity integer

Количество.
Артикул (SKU)
 products.sku string

Номер SKU.
Имя
 products.name string

Имя.

Получение статистики трансляции

Идентификатор операции:
BroadcastGetStat

Извлекает статистику (число получателей, открытую частоту, скорость щелчка мыши, количество отмены подписки, общее количество щелчков, состояние и ход отправки) для определенной трансляции.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор трансляции
 broadcast_id True string

Уникальный идентификатор трансляции.

Возвращаемое значение

Имя Путь Тип Описание
Вещать
 broadcast array of object
Идентификатор
 broadcast.id integer

Уникальный идентификатор.
Получатели
 broadcast.stats.recipients integer

Получатели.
Открытие ставки
 broadcast.stats.open_rate float

Открытая ставка.
Скорость нажатия кнопки
 broadcast.stats.click_rate float

Частота щелчков.
Отмены подписки
 broadcast.stats.unsubscribes integer

Отмена подписки.
Всего щелчков
 broadcast.stats.total_clicks integer

Общее количество щелчков.
Показать всего щелчков
 broadcast.stats.show_total_clicks boolean

Указывает, следует ли отображать общее количество щелчков.
Состояние
 broadcast.stats.status string

Состояние.
Progress
 broadcast.stats.progress integer

Ход выполнения.

Получение трансляции

Идентификатор операции:
BroadcastGet

Извлекает сведения о определенной трансляции, включая черновик, запланированные и ранее отправленные трансляции.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор трансляции
 broadcast_id True string

Уникальный идентификатор трансляции.

Возвращаемое значение

Имя Путь Тип Описание
Идентификатор
 broadcast.id integer

Уникальный идентификатор.
Создано в
 broadcast.created_at string

При создании.
Тема
 broadcast.subject string

Тема.
Description
 broadcast.description string

Описание.
Content
 broadcast.content string

Содержимое.
Публика
 broadcast.public boolean

Является ли общедоступным.
Опубликовано в
 broadcast.published_at string

При публикации на сайте.
Отправка по адресу
 broadcast.send_at string

При отправке.
Замещающий эскиз
 broadcast.thumbnail_alt string

Замещающий текст эскиза.
URL-адрес эскиза
 broadcast.thumbnail_url string

URL-адрес эскиза.
Электронная почта
 broadcast.email_address string

Адрес электронной почты.
Шаблон макета электронной почты
 broadcast.email_layout_template string

Шаблон макета электронной почты.

Получение учетной записи

Идентификатор операции:
Account

Извлекает текущую учетную запись.

Возвращаемое значение

Имя Путь Тип Описание
Имя
 name string

Имя.
Тип плана
 plan_type string

Тип плана.
Основной адрес электронной почты
 primary_email_address string

Основной адрес электронной почты.

Получение форм

Идентификатор операции:
FormList

Получение списка всех форм для учетной записи.

Возвращаемое значение

Имя Путь Тип Описание
Формы
 forms array of object
Идентификатор
 forms.id integer

Уникальный идентификатор.
Имя
 forms.name string

Имя.
Создано в
 forms.created_at string

При создании.
Тип
 forms.type string

Тип.
Формат
 forms.format string

Формат.
URL
 forms.url string

URL-адрес.
Внедрение JS
 forms.embed_js string

Javascript для внедрения.
URL-адрес внедрения
 forms.embed_url string

URL-адрес для внедрения.
Название
 forms.title string

Заголовок.
Description
 forms.description string

Описание.
Текст кнопки регистрации
 forms.sign_up_button_text string

Текст кнопки регистрации.
Сообщение об успешном выполнении
 forms.success_message string

Сообщение об успешном выполнении.
Archived
 forms.archived boolean

Архивировано ли.
ИД пользователя
 forms.uid string

Уникальный идентификатор.

Создание покупки

Идентификатор операции:
PurchaseAdd

Создайте покупку.

Параметры

Имя Ключ Обязательно Тип Описание
Код проводки
 transaction_id True string

Уникальный идентификатор транзакции.
Электронная почта
 email_address True string

Адрес электронной почты.
Имя (Первое имя)
 first_name string

Первое имя.
Валюта
 currency True string

Валюта.
Время транзакции
 transaction_time string

Время транзакции.
Промежуточный итог
 subtotal integer

Промежуточный итог.
Налоги
 tax integer

Налог.
Судоходство
 shipping integer

Доставка.
Скидка
 discount integer

Скидка.
Total
 total integer

Общее число.
Состояние
 status string

Состояние.
ИД процесса
 pid True integer

Личный идентификатор.
КРЫШКА
 lid True integer

The LID.
Имя
 name True string

Имя.
Артикул (SKU)
 sku string

Номер SKU.
Цена за единицу
 unit_price True integer

Цена за единицу.
Количество
 quantity True integer

Количество.

Возвращаемое значение

Имя Путь Тип Описание
Идентификатор
 id integer

Уникальный идентификатор.
Код проводки
 transaction_id string

Уникальный идентификатор транзакции.
Состояние
 status string

Состояние.
Электронная почта
 email_address string

Адрес электронной почты.
Валюта
 currency string

Валюта.
Время транзакции
 transaction_time string

Время транзакции.
Промежуточный итог
 subtotal integer

Промежуточный итог.
Скидка
 discount integer

Скидка.
Налоги
 tax integer

Налог.
Судоходство
 shipping integer

Доставка.
Total
 total integer

Общее число.
Products
 products array of object
Цена за единицу
 products.unit_price integer

Цена за единицу.
Количество
 products.quantity integer

Количество.
Артикул (SKU)
 products.sku string

Номер SKU.
Имя
 products.name string

Имя.

Создание тега

Идентификатор операции:
TagAdd

Создает новый тег.

Параметры

Имя Ключ Обязательно Тип Описание
Имя
 name True string

Имя.

Возвращаемое значение

Имя Путь Тип Описание
ID счета
 account_id integer

Уникальный идентификатор учетной записи.
Создано в
 created_at string

При создании.
Удалено в
 deleted_at string

При удалении по адресу.
Идентификатор
 id integer

Уникальный идентификатор.
Имя
 name string

Имя.
Государство
 state string

Государство.
Обновлено в
 updated_at string

При обновлении по адресу.

Создание трансляции

Идентификатор операции:
BroadcastAdd

Создайте черновик или запланированную трансляцию. Вы можете создать черновик трансляции без каких-либо атрибутов. Запланированные трансляции должны содержать строку темы и содержимое.

Параметры

Имя Ключ Обязательно Тип Описание
Description
 description string

Описание.
Тема
 subject string

Тема.
Content
 content string

Содержимое.
Электронная почта
 email_address string

Адрес электронной почты.
Шаблон макета электронной почты
 email_layout_template string

Шаблон макета электронной почты.
Публика
 public boolean

Является ли общедоступным.
Опубликовано в
 published_at string

При публикации на сайте.
Отправка по адресу
 send_at string

При отправке.
Замещающий эскиз
 thumbnail_alt string

Замещающий текст эскиза.
URL-адрес эскиза
 thumbnail_url string

URL-адрес эскиза.

Возвращаемое значение

Имя Путь Тип Описание
Идентификатор
 broadcast.id integer

Уникальный идентификатор.
Создано в
 broadcast.created_at string

При создании.
Тема
 broadcast.subject string

Тема.
Description
 broadcast.description string

Описание.
Content
 broadcast.content string

Содержимое.
Публика
 broadcast.public boolean

Является ли общедоступным.
Опубликовано в
 broadcast.published_at string

При публикации на сайте.
Отправка по адресу
 broadcast.send_at string

При отправке.
Замещающий эскиз
 broadcast.thumbnail_alt string

Замещающий текст эскиза.
URL-адрес эскиза
 broadcast.thumbnail_url string

URL-адрес эскиза.
Электронная почта
 broadcast.email_address string

Адрес электронной почты.
Шаблон макета электронной почты
 broadcast.email_layout_template string

Шаблон макета электронной почты.

Список широковещательных трансляций

Идентификатор операции:
BroadcastList

Извлекает список всех трансляций для вашей учетной записи.

Возвращаемое значение

Имя Путь Тип Описание
Трансляции
 broadcasts array of object
Идентификатор
 broadcasts.id integer

Уникальный идентификатор.
Создано в
 broadcasts.created_at string

При создании.
Тема
 broadcasts.subject string

Тема.

Тег подписчика

Идентификатор операции:
TagSub

Теги обрабатываются как подписки. Подпишите адрес электронной почты на тег, чтобы этот тег был применен к подписчику с помощью этого адреса электронной почты.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор тега
 tag_id True string

Уникальный идентификатор тега.
Адрес электронной почты
 email string

Адрес электронной почты.
Имя (Первое имя)
 first_name string

Первое имя.
Метки
 tags array of integer

Возвращаемое значение

Имя Путь Тип Описание
Идентификатор
 subscription.id integer

Уникальный идентификатор.
Государство
 subscription.state string

Государство.
Создано в
 subscription.created_at string

При создании.
Исходный материал
 subscription.source string

Источник.
Источник перехода
 subscription.referrer string

Ссылщик.
Идентификатор подписки
 subscription.subscribable_id integer

Подписываемый уникальный идентификатор.
Тип подписки
 subscription.subscribable_type string

Тип подписки.
Идентификатор
 subscription.subscriber.id integer

Уникальный идентификатор.

Теги списка

Идентификатор операции:
TagList

Извлекает список тегов для учетной записи.

Возвращаемое значение

Имя Путь Тип Описание
Метки
 tags array of object
Идентификатор
 tags.id integer

Уникальный идентификатор.
Имя
 tags.name string

Имя.
Создано в
 tags.created_at string

При создании.

Удаление тега из подписчика

Идентификатор операции:
TagSubRemove

Удаляет тег из подписчика.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор подписчика
 subscriber_id True string

Уникальный идентификатор подписчика.
Идентификатор тега
 tag_id True string

Уникальный идентификатор тега.

Возвращаемое значение

Имя Путь Тип Описание
Идентификатор
 id integer

Уникальный идентификатор.
Имя
 name string

Имя.
Создано в
 created_at string

При создании.

Удаление тега из подписчика по электронной почте

Идентификатор операции:
TagSubRemoveEmail

Удалите тег из подписчика по адресу электронной почты.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор тега
 tag_id True string

Уникальный идентификатор тега.
Адрес электронной почты
 email True string

Адрес электронной почты.

Возвращаемое значение

Имя Путь Тип Описание
Идентификатор
 id integer

Уникальный идентификатор.
Имя
 name string

Имя.
Создано в
 created_at string

При создании.

Уничтожение трансляции

Идентификатор операции:
BroadcastDelete

Окончательно удалите черновик или запланированную запись трансляции. Трансляции, отправляемые в настоящее время или отправленные, могут быть удалены.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор трансляции
 broadcast_id True string

Уникальный идентификатор трансляции.

Возвращаемое значение

response
string

Определения

струна

Это базовый тип данных string.