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

Эндпоинты

Одобрение партнеров, проверка помеченных конверсий и отправка выплат выполняются в панели управления.

Суммы и ID

  • Суммы в ответах API указываются целыми числами в минимальных единицах валюты. commission: 499 в USD означает $4.99.
  • В данных вебхуков используются основные единицы. commission: 4.99 означает $4.99.
  • Партнеры и выплаты используют публичные ID длиной 16 символов. Конверсии используют публичный invoice_id заказа.

Пагинация

Эндпоинты списков возвращают 25 элементов на страницу и next_cursor. Передайте его обратно как cursor, чтобы получить следующую страницу. На последней странице next_cursor равен null.
Каждый список также возвращает counts, количество записей по каждому статусу:

Пригласите партнера

Ответ (201)
Ключи только для чтения не могут приглашать партнеров.

Как атрибутируются заказы

Заказ засчитывается партнеру одним из следующих способов, в порядке приоритета:
  1. Купон партнера. Покупатель использовал купон, привязанный к партнеру.
  2. Ссылка отслеживания. Покупатель открыл партнерскую ссылку: https://your-store.com/any-page?ref=CODE или https://your-store.com/r/CODE. Витрина запоминает переход на срок действия cookie, заданный в программе.
  3. API. Вы передали affiliateCode при создании счета. У конверсии будет source: "api".
Конверсия отклоняется, если покупатель и есть партнер, или если использован другой купон, а программа не разрешает суммирование купонов. Она помечается для проверки, если у заказа высокий показатель риска мошенничества или партнер получает необычно много заказов за короткое время.

Состояния комиссии

Возвраты автоматически отменяют комиссию. commission всегда содержит чистую сумму.

Вебхуки

Подпишитесь на эти события в разделе Разработчикам › Вебхуки. Они используют ту же оболочку и заголовок PapelShip-Signature, что и события заказов.
affiliate.conversion
affiliate.payout_sent

Ошибки

Партнерские ошибки содержат машиночитаемый code: