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