Ваш магазин должен быть одобрен для участия в партнерской программе. Подайте заявку в панели управления в разделе Партнеры. До одобрения каждый партнерский эндпоинт возвращает
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)
Как атрибутируются заказы
Заказ засчитывается партнеру одним из следующих способов, в порядке приоритета:- Купон партнера. Покупатель использовал купон, привязанный к партнеру.
- Ссылка отслеживания. Покупатель открыл партнерскую ссылку:
https://your-store.com/any-page?ref=CODEилиhttps://your-store.com/r/CODE. Витрина запоминает переход на срок действия cookie, заданный в программе. - API. Вы передали
affiliateCodeпри создании счета. У конверсии будетsource: "api".
Состояния комиссии
Возвраты автоматически отменяют комиссию.
commission всегда содержит чистую сумму.
Вебхуки
Подпишитесь на эти события в разделе Разработчикам › Вебхуки. Они используют ту же оболочку и заголовокPapelShip-Signature, что и события заказов.
affiliate.conversion
affiliate.payout_sent
Ошибки
Партнерские ошибки содержат машиночитаемыйcode: