Affiliate Manager
Affiliate Manager API
Documentación de la API de Affiliate Manager
Servidor base: https://services.leadconnectorhq.com
Endpoints
- GET /affiliate-manager/{locationId}/affiliates — Listar afiliados
- GET /affiliate-manager/{locationId}/affiliates/{affiliateId} — Obtener afiliado
- GET /affiliate-manager/{locationId}/payouts — Listar Payouts
- GET /affiliate-manager/{locationId}/commissions — Listar Commissions
GET /affiliate-manager/{locationId}/affiliates
Listar afiliados Retrieve the list of affiliates for a location.
Scopes requeridos: affiliate-manager.readonly
Parametros:
- Versión (header, string) (requerido) — Versión de la API
- locationId (path, string) (requerido) — Id de sede
- query (query, string) —
- active (query, string) —
- campaignId (query, string) —
- skip (query, number) —
- limit (query, number) — Maximum number of records to return. Maximum allowed value is 100.
- fromDate (query, string) —
- toDate (query, string) —
Respuestas:
- 200 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
GET /affiliate-manager/{locationId}/affiliates/{affiliateId}
Obtener afiliado Retrieve a single affiliate by id for a location.
Scopes requeridos: affiliate-manager.readonly
Parametros:
- Versión (header, string) (requerido) — Versión de la API
- locationId (path, string) (requerido) — Id de sede
- affiliateId (path, string) (requerido) — Id de afiliado
Respuestas:
- 200 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
GET /affiliate-manager/{locationId}/payouts
Listar Payouts Retrieve the list of payouts for a location.
Scopes requeridos: affiliate-manager.readonly
Parametros:
- Versión (header, string) (requerido) — Versión de la API
- locationId (path, string) (requerido) — Id de sede
- status (query, string) — Payout status
- query (query, string) — query
- affiliateId (query, string) — Id de afiliado
- campaignId (query, string) — Id de campaña
- skip (query, number) —
- limit (query, number) —
- start (query, string) —
- end (query, string) —
Respuestas:
- 200 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
GET /affiliate-manager/{locationId}/commissions
Listar Commissions Retrieve the list of commissions for a location.
Scopes requeridos: affiliate-manager.readonly
Parametros:
- Versión (header, string) (requerido) — Versión de la API
- locationId (path, string) (requerido) — Id de sede
- campaignId (query, string) — Id de campaña
- affiliateId (query, string) — Id de afiliado
- status (query, string) — Status
- query (query, string) — Query
- skip (query, number) —
- limit (query, number) — Maximum number of records to return. Maximum allowed value is 100.
- fromDate (query, string) —
- toDate (query, string) —
Respuestas:
- 200 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
