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

Ендпоінти

Схвалення партнерів, перевірка позначених конверсій і надсилання виплат залишаються в панелі керування.

Суми та ID

  • Суми у відповідях API є цілими числами в дрібних одиницях. commission: 499 у USD означає $4.99.
  • Дані вебхуків використовують основні одиниці. commission: 4.99 означає $4.99.
  • Партнери та виплати мають 16-символьні публічні ID. Конверсії використовують публічний 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 завжди є чистою сумою.

Вебхуки

Підпишіться на ці події в розділі Developers › Webhooks. Вони використовують ту саму обгортку та заголовок PapelShip-Signature, що й події замовлень.
affiliate.conversion
affiliate.payout_sent

Помилки

Партнерські помилки містять машиночитний code: