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: 499enUSDequivale a $4.99. - Las cargas de los webhooks usan unidades mayores.
commission: 4.99equivale a $4.99. - Los socios y los pagos usan ID públicos de 16 caracteres. Las conversiones usan el
invoice_idpúblico del pedido.
Paginación
Los endpoints de lista devuelven 25 elementos por página con unnext_cursor. Envíelo de vuelta como cursor para obtener la página siguiente. next_cursor es null en la última página.
counts, el número de registros por estado:
Invitar a un socio
Respuesta (201)
Cómo se atribuyen los pedidos
Un pedido se acredita a un socio de una de estas formas, por orden de prioridad:- Cupón del socio. El comprador usó un cupón vinculado al socio.
- Enlace de seguimiento. El comprador abrió un enlace del socio:
https://your-store.com/any-page?ref=CODEohttps://your-store.com/r/CODE. La tienda recuerda el clic durante la ventana de cookie del programa. - API. Usted envió
affiliateCodeal crear la factura. La conversión tienesource: "api".
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 encabezadoPapelShip-Signature que los eventos de pedidos.
affiliate.conversion
affiliate.payout_sent
Errores
Los errores de afiliados incluyen uncode legible por máquina: