Saltar al contenido principal
Use los endpoints de afiliados para sincronizar su programa de socios con sus propios sistemas: liste socios, haga seguimiento de los pedidos atribuidos y controle los pagos.
Su tienda debe estar aprobada para el programa de afiliados. Solicítelo en el panel, en Afiliados. Hasta entonces, todos los endpoints de afiliados devuelven 403 con el código FEATURE_NOT_ENABLED.

Endpoints

La aprobación de socios, la revisión de conversiones marcadas y el envío de pagos se siguen haciendo en el panel.

Importes e ID

  • Los importes en las respuestas de la API son enteros en unidades menores. commission: 499 en USD equivale a $4.99.
  • Las cargas de los webhooks usan unidades mayores. commission: 4.99 equivale a $4.99.
  • Los socios y los pagos usan ID públicos de 16 caracteres. Las conversiones usan el invoice_id público del pedido.

Paginación

Los endpoints de lista devuelven 25 elementos por página con un next_cursor. Envíelo de vuelta como cursor para obtener la página siguiente. next_cursor es null en la última página.
Cada lista también devuelve counts, el número de registros por estado:

Invitar a un socio

Respuesta (201)
Las claves de solo lectura no pueden invitar a socios.

Cómo se atribuyen los pedidos

Un pedido se acredita a un socio de una de estas formas, por orden de prioridad:
  1. Cupón del socio. El comprador usó un cupón vinculado al socio.
  2. Enlace de seguimiento. El comprador abrió un enlace del socio: https://your-store.com/any-page?ref=CODE o https://your-store.com/r/CODE. La tienda recuerda el clic durante la ventana de cookie del programa.
  3. API. Usted envió affiliateCode al crear la factura. La conversión tiene source: "api".
La conversión se rechaza cuando el comprador es el propio socio, o cuando se usa otro cupón y el programa no permite combinar cupones. Se marca para revisión cuando el pedido tiene una puntuación de fraude alta o el socio recibe un número inusual de pedidos en poco tiempo.

Estados de la comisión

Los reembolsos revierten la comisión automáticamente. commission siempre es el importe neto.

Webhooks

Suscríbase a estos eventos en Desarrolladores › Webhooks. Usan el mismo sobre y el mismo encabezado PapelShip-Signature que los eventos de pedidos.
affiliate.conversion
affiliate.payout_sent

Errores

Los errores de afiliados incluyen un code legible por máquina: