Referencia de la API de Addrevenue

Referencia de la API de Addrevenue (borrador)

Nuestra API REST se ha desarrollado para satisfacer las necesidades de afiliados y anunciantes. Debe generar un token de API de por vida manualmente en nuestra interfaz de usuario. Este token Bearer se envía luego como encabezado de Authorization en cada solicitud.

URL base de la API

Todos los endpoints comienzan con la URL base:

https://addrevenue.io/api/v2

Utilice siempre el protocolo HTTPS.

Autenticación

Para generar un token, inicie sesión en Addrevenue y vaya a API tokens, luego Generate a new API token. Esto crea un token de API único y de por vida para la cuenta con la que inició sesión.

El token debe enviarse luego como token Bearer en todas las solicitudes a cualquier endpoint de la API.

Ejemplo de un encabezado:

Authorization: Bearer 1892cd44-c59c-42bf-9f1d-a5316ea695cc
Content-type: application/json

Errores

El envío de un token Bearer vacío, mal formado o inválido dará lugar a uno de estos errores HTTP:

Estado Mensaje Causa
400 Authorization header not found El encabezado Authorization falta o está mal formado, por ejemplo si falta el prefijo "Bearer".
403 Invalid token El encabezado tiene el formato correcto, pero el token de API proporcionado no existe.
403 Inactive account El encabezado tiene el formato correcto y el token existe, pero pertenece a una cuenta que no está activa.
403 (mensaje específico del endpoint) El endpoint no está disponible para este tipo de cuenta, por ejemplo "Endpoint only available to affiliates".
404 Endpoint not found El endpoint solicitado no existe.

Las respuestas de error tienen este aspecto:

{
    "error": {
        "message": "Invalid token"
    }
}

Respuestas

Todas las respuestas están en formato JSON. Una respuesta exitosa contiene un array results, un objeto meta (recuento de elementos y paginación), y un objeto links (enlaces de paginación):

{
    "results": [
        { "id": 1000, "description": "Sample campaign A" },
        { "id": 1001, "description": "Sample campaign B" }
    ],
    "meta": {
        "count": 2,
        "totalCount": 27,
        "page": 1,
        "perPage": 2,
        "totalPages": 14,
        "hasPrevPage": false,
        "hasNextPage": true
    },
    "links": {
        "self": "https://addrevenue.io/api/v2/campaigns?limit=2",
        "next": "https://addrevenue.io/api/v2/campaigns?limit=2&page=2"
    }
}

results es siempre un array, incluso para un único resultado. meta.totalCount es el número total de elementos que coinciden en todas las páginas, no solo en la página actual. A continuación, cada endpoint enumera los campos que puede esperar dentro de cada elemento de results, y cuáles de esos campos también se pueden usar como filtro.

Endpoints de la API

Parámetros de solicitud

Puede filtrar la mayoría de los endpoints añadiendo un parámetro en la cadena de consulta con el mismo nombre que uno de los campos propios del elemento — por ejemplo id, status, market, advertiserId, o channelId. Esto solo funciona con campos que contienen un valor estático y almacenado — la tabla de campos de respuesta de cada endpoint, más abajo, indica qué campos se pueden filtrar de esta manera. No funciona con campos que se calculan o derivan de otros datos (por ejemplo advertiserName, commissionShort, o epc), ni con objetos y arrays anidados (por ejemplo markets o programs). Filtrar por un campo no filtrable devuelve un error en lugar de ser ignorado silenciosamente.

Paginación

Utilice limit (elementos por página) y page (número de página, empezando en 1) para recorrer los resultados, por ejemplo /products?limit=50&page=2. offset también se admite como alternativa heredada a page.

Intervalos de fecha

En los endpoints donde sea aplicable, puede filtrar por un intervalo de fechas usando fromDate y/o toDate — ya sea juntos, para establecer un intervalo, o por separado. Esto filtra por la fecha de creación del registro (su campo date, en el caso de stats y trackingErrors) — cada endpoint, más abajo, indica si esto es compatible.

Cuando se indique, también puede usar updatedFromDate/updatedToDate, que filtran por la fecha en que un elemento se actualizó por última vez en lugar de cuándo se creó.

Anunciantes

GET /advertisers

Accesible para

Todos los tipos de cuenta.

Las cuentas de afiliado ven todos los anunciantes activos — pase channelId para restringir la lista a los anunciantes con una relación (activa, pendiente o rechazada) con ese canal. Las cuentas de anunciante ven solo su propia cuenta. Las cuentas de agencia ven los anunciantes que gestionan.

Parámetros de solicitud

Parámetro Descripción
channelId Opcional (solo afiliados). Restringe los resultados a anunciantes con una relación con este canal, y añade relation/relationStatus a cada resultado.
expand Opcional. Establézcalo en 1 para incluir también programs y landingPages para cada anunciante.
fromDate, toDate Opcional. Filtra por fecha de creación.

Campos de respuesta

Campo Filtrable Descripción
id Sí ID del anunciante.
name Sí Razón social.
displayName Sí Nombre público para mostrar.
address, zipcode, city, country Sí Dirección de la empresa.
shortDescription — Descripción corta de marketing.
categoryId Sí Categoría, p. ej. insurance, foodDrink.
logoImageFilename — URL absoluta de la imagen del logotipo.
url — Sitio web del anunciante.
type — Siempre advertiser.
orgno, vatno Sí Número de organización y número de IVA.
businessType — Tipo de entidad comercial.
autoApproveChannels Sí Si las nuevas relaciones de canal se aprueban automáticamente.
policyPaidAds/restrictionPaidAds Sí Política de anuncios pagados (allowed/notAllowed) y cualquier restricción en texto libre.
policySocialMedia/restrictionSocialMedia Sí Política de redes sociales y restricción.
policyEmailMarketing/restrictionEmailMarketing Sí Política de email marketing y restricción.
policyCouponRebate/restrictionCouponRebate Sí Política de cupones/descuentos y restricción.
policyCashbackReward/restrictionCashbackReward Sí Política de cashback/recompensas y restricción.
ecommercePlatform Sí p. ej. shopify, customBuilt.
trackingMethod Sí Método de integración de seguimiento.
discountCodeTracking Sí Si el seguimiento de códigos de descuento está habilitado.
approvedForPrepayouts Sí Si el anunciante está aprobado para pagos anticipados.
customTrackingParameters Sí Parámetros de consulta adicionales añadidos a los enlaces de seguimiento.
markets — Objeto indexado por código de mercado. Cada mercado tiene market, displayName, url, status, presentation (HTML), shortDescription, affiliatePageUrl, productFeedUrl, redirectUrl, endedDate, endedReason, activatedDate, productCount.
programs — Solo con channelId o expand. Programas de comisión — consulte el endpoint Programas para más detalles de los campos.
landingPages — Solo con expand.
relation/relationStatus — Solo con channelId. La relación de su canal con este anunciante, y su estado.

Banners

GET /banners

Accesible para

Todos los tipos de cuenta.

Las cuentas de afiliado ven grupos de banners de todos los anunciantes activos — pase channelId para obtener también un código de seguimiento para cada banner. Las cuentas de anunciante y agencia ven todos los grupos de banners de su(s) propio(s) anunciante(s), incluidos los inactivos.

Parámetros de solicitud

Parámetro Descripción
channelId Opcional (solo afiliados). Si se proporciona, se incluyen códigos de seguimiento para todos los banners en la respuesta.
fromDate, toDate Opcional. Filtra por fecha de creación.

Campos de respuesta

Campo Filtrable Descripción
id Sí ID del grupo de banners.
created Sí Cuándo se creó el grupo de banners.
name, description Sí Nombre y descripción del grupo de banners.
url Sí URL de destino opcional que sobrescribe la del grupo.
advertiserId Sí El anunciante al que pertenece este grupo.
advertiserName — El nombre público del anunciante.
banners — Objeto indexado por ID de banner. Cada banner tiene id, created, width, height, filesize, format, filename, y, solo con channelId, trackingLink, imageLink, bannerHtmlCode (un fragmento <a><img></a> listo para insertar).

GET /brokenLinks

Accesible para

Solo afiliados.

Campos de respuesta

Campo Filtrable Descripción
id — ID del enlace roto.
url — La URL rota.
httpCode — El código de estado HTTP encontrado, p. ej. 404.
created — Cuándo se detectó el enlace roto.

Este endpoint siempre cubre una ventana fija de 30 días y devuelve el conjunto completo de resultados — los parámetros de solicitud (incluidos la paginación y los filtros de fecha) no son compatibles aquí.

Campañas

GET /campaigns

Accesible para

Todos los tipos de cuenta.

Las cuentas de afiliado ven todas las campañas públicas activas de todos los anunciantes, además de cualquier campaña exclusiva de canal para sus propios canales — pase channelId para restringir a anunciantes con una relación aprobada con ese canal, lo que también añade un trackingLink a cada campaña. Las cuentas de anunciante y agencia ven todas las campañas de su(s) propio(s) anunciante(s) — activas e inactivas, públicas y exclusivas de canal.

Parámetros de solicitud

Parámetro Descripción
channelId Opcional (solo afiliados). Restringe a anunciantes con una relación aprobada con el canal, y añade trackingLink a cada campaña.
fromDate, toDate Opcional. Filtra por fecha de creación.

Campos de respuesta

Campo Filtrable Descripción
id Sí ID de la campaña.
advertiserId Sí El anunciante que ejecuta la campaña.
advertiserName, advertiserUrl — El nombre público y el sitio web del anunciante.
description Sí Descripción de la campaña.
discountCode Sí El código de descuento, si es una campaña de tipo cupón.
url Sí Página de destino de la campaña.
terms Sí Texto de términos y condiciones.
validFrom, validTo Sí Período de validez.
channelId Sí Solo definido para campañas exclusivas de canal.
created Sí Cuándo se creó la campaña.
bannerGroupId Sí Grupo de banners vinculado, si existe.
type — coupon u offer.
status — active o ended.
markets — Array de códigos de mercado a los que aplica la campaña.
trackingLink — Solo con channelId. Su enlace con etiqueta de canal a la URL de la campaña.

Canales

GET /channels

Accesible para

Solo afiliados.

Parámetros de solicitud

Parámetro Descripción
fromDate, toDate Opcional. Filtra por fecha de creación.

Campos de respuesta

Campo Filtrable Descripción
id Sí ID del canal.
affiliateId Sí El ID de su cuenta de afiliado.
name, url Sí Nombre del canal y URL del sitio web.
type Sí p. ej. website.
visitors Sí Volumen estimado de visitantes.
status Sí Estado del canal.
created Sí Cuándo se creó el canal.
markets — Array de códigos de mercado, o null.

Eventos

GET /events

Accesible para

Todos los tipos de cuenta, limitados a su(s) propio(s) anunciante(s)/canal(es) como es habitual — no hay diferencia de comportamiento entre tipos de cuenta más allá de eso.

Parámetros de solicitud

Parámetro Descripción
fromDate, toDate Opcional. Filtra por fecha de creación — tenga en cuenta que esto filtra por created, no por el campo date independiente que aparece en la respuesta.

Campos de respuesta

Campo Filtrable Descripción
id Sí ID del evento.
date, created Sí Fecha del evento y marca de tiempo completa.
advertiserId, channelId Sí El anunciante y el canal involucrados.
type Sí Tipo de evento, p. ej. Click. Varía según la integración de cada anunciante y no es una lista fija.
url Sí URL de la página donde ocurrió el evento.
value, currency Sí Valor del pedido y moneda, si corresponde.
orderId Sí ID del pedido del anunciante, si corresponde.
sandbox Sí Si se trató de un evento de prueba/sandbox.
referrer Sí Referente HTTP.
clickId Sí El clic con el que está asociado este evento.
bannerId Sí El banner en el que se hizo clic, si corresponde.
clickRef Sí Referencia interna del clic.
market Sí Código de mercado.
redirectUrl Sí La página de destino del anunciante a la que redirigió el clic.
affiliateUrl Sí La URL de la página de origen del afiliado.
affiliateGclid, wctid Sí IDs de clic de Google Ads / otras plataformas publicitarias, si están presentes.
easylink Sí Si este evento llegó a través de un Easylink.
deviceType Sí desktop, mobile, tablet, o backend.
crossDeviceId Sí ID de seguimiento entre dispositivos, si está disponible.
subids Sí Sus propios parámetros de sub-ID, si se enviaron.

Impresiones

GET /impressions

Accesible para

Todos los tipos de cuenta, limitados a su(s) propio(s) anunciante(s)/canal(es) como es habitual — no hay diferencia de comportamiento entre tipos de cuenta más allá de eso.

Parámetros de solicitud

Parámetro Descripción
fromDate, toDate Opcional. Filtra por fecha de creación.

Campos de respuesta

Campo Filtrable Descripción
id Sí ID de la impresión.
date, created Sí Fecha de la impresión y marca de tiempo completa.
advertiserId, channelId Sí El anunciante y el canal involucrados.
url Sí URL de la página donde ocurrió la impresión.
referrer Sí Referente HTTP.
bannerId Sí El banner que se mostró.
market Sí Código de mercado.
deviceType Sí desktop, mobile, tablet, o backend.

Leads

POST /leads

Accesible para

Solo afiliados. Actualmente admite un conjunto limitado de anunciantes integrados.

Cuerpo de la solicitud

Campo Descripción
channelId Obligatorio. Debe ser uno de sus propios canales.
advertiserId Obligatorio. Debe ser un anunciante integrado con la API de Leads, y debe tener una relación activa con el canal indicado.
(otros campos) Específicos del anunciante — se envían tal cual al sistema de captación de leads del anunciante.

La respuesta se devuelve tal cual desde el sistema de captación de leads del anunciante, en lugar del formato estándar results/meta que usan los demás endpoints.

Pagos

GET /payouts

Accesible para

Solo afiliados.

Parámetros de solicitud

Parámetro Descripción
fromDate, toDate Opcional. Filtra por fecha de creación.

Campos de respuesta

Campo Filtrable Descripción
id Sí ID del pago.
affiliateId Sí El ID de su cuenta de afiliado.
date, created Sí Fecha del pago y cuándo se creó el pago.
name Sí Nombre del beneficiario.
payoutDate Sí Cuándo se realizó realmente el pago.
address, zipcode, city, country Sí Dirección del beneficiario.
orgno, vatno Sí Número de organización y número de IVA.
status Sí Estado del pago.
sum, vat, total Sí Importe antes de IVA, importe de IVA, y total.
currency Sí Moneda del pago.
payoutMethod Sí p. ej. el método de transferencia bancaria utilizado.
gigapayPayoutId Sí Referencia al pago de Gigapay, si se utilizó.
gigapayPayout — Detalles ampliados del pago de Gigapay, si se utilizó.
currencyExchangeFee Sí Comisión aplicada por conversión de moneda, si corresponde.
taxRate Sí Tipo impositivo aplicado.
bankCountry Sí País del banco, si corresponde.
manualAdjustment Sí Cualquier ajuste manual aplicado al pago.
noOfTransactions — Número de transacciones incluidas.
kickbackRows, noOfKickbackRows — Líneas de kickback, si existen.
language — Idioma en el que se generó el documento de pago.
accountNumber — Número de cuenta bancaria del beneficiario.
periodFrom, periodTo, periodText — El período que cubre este pago.
vatText — Texto de la nota de IVA mostrado en el documento de pago.
reverseCharge — Si aplica la inversión del sujeto pasivo de IVA.
rows — Líneas de detalle en el documento de pago.
transactions — Objeto indexado por ID de transacción — mismos campos que el endpoint de Transacciones más abajo.

Feeds de productos

GET /productfeeds

Accesible para

Todos los tipos de cuenta.

Las cuentas de afiliado ven los metadatos del feed de todos los anunciantes con una obtención de feed completada — pase channelId para restringir esto a anunciantes con una relación activa con ese canal, lo que también etiqueta la URL del feed para el seguimiento de ese canal. Las cuentas de anunciante y agencia siempre ven solo los feeds de su(s) propio(s) anunciante(s).

Parámetros de solicitud

Parámetro Descripción
channelId Opcional. Ver más arriba.
detectedCurrency Opcional. Filtra los feeds cuya moneda detectada automáticamente coincida.
detectedLanguage Opcional. Filtra los feeds cuyo idioma detectado automáticamente coincida.

Los filtros de fecha (fromDate/toDate) y la paginación no son compatibles en este endpoint — siempre devuelve el conjunto completo de resultados para cada obtención de feed completada.

Campos de respuesta

Campo Filtrable Descripción
advertiserId Sí El anunciante al que pertenece este feed.
advertiserName — El nombre público del anunciante.
market — Código de mercado que cubre el feed.
sourceProductFeedUrl — La URL original del feed del anunciante.
url/productFeedUrl — Solo con channelId. Su URL de feed con etiqueta de canal.
started, finished Sí Cuándo comenzó y finalizó la obtención del feed. Mismos valores que latestFetchDate/latestFetchFinished más abajo.
latestFetchDate, latestFetchFinished — Nombres duplicados, más descriptivos, de started/finished.
checksum Sí Suma de comprobación del feed obtenido, para detección de cambios. Mismo valor que latestFetchChecksum.
latestFetchChecksum — Duplicado de checksum.
products — Número de productos en el feed.
hasGtin — Número de productos en el feed que incluyen un GTIN.
detectedCurrency, detectedLanguage Sí Moneda e idioma del feed detectados automáticamente.

Productos

GET /products

Accesible para

Todos los tipos de cuenta.

Las cuentas de anunciante y agencia ven su propio catálogo completo, incluidos los productos ocultos. Las cuentas de afiliado ven solo los productos visibles de anunciantes con un mercado activo.

Parámetros de solicitud

Parámetro Descripción
limit Opcional. Número de productos por página.
page Opcional. Número de página.
channelId Opcional (afiliados). Añade un trackingLink a cada producto.

Ejemplo: /products?limit=50&page=2

Los filtros de fecha (fromDate/toDate) no son compatibles en este endpoint.

Campos de respuesta

Campo Filtrable Descripción
id Sí ID interno del producto.
advertiserId Sí El anunciante que vende este producto.
market Sí Código de mercado.
title Sí Título del producto.
link Sí URL de la página del producto.
product_type, google_product_category Sí Campos de categoría, según la especificación del feed de Google Shopping.
image_link Sí URL de la imagen del producto.
condition Sí p. ej. new.
availability Sí p. ej. in_stock.
price, sale_price, currency Sí Precio regular, precio de oferta, y moneda.
shipping, size, color, gender, material, age_group Sí Atributos del producto, cuando estén disponibles.
min_handling_time, max_handling_time — Tiempo de gestión en días antes del envío, incluido solo cuando el anunciante ha configurado un valor de respaldo para su feed.
brand Sí Nombre de la marca.
sku, mpn, gtin, product_id, item_group_id Sí Identificadores del producto.
hidden Sí Si el producto está oculto para las cuentas que no son de anunciante.
checksum Sí Suma de comprobación de los datos del producto, para detección de cambios.
has_image_link Sí Si hay una URL de imagen disponible.
trackingLink — Solo con channelId. Su enlace con etiqueta de canal a la página del producto.

Programas

GET /programs

Accesible para

Todos los tipos de cuenta.

Las cuentas de afiliado ven solo los programas activos. Las cuentas de anunciante y agencia ven todos sus programas, independientemente del estado.

Parámetros de solicitud

Parámetro Descripción
fromDate, toDate Opcional. Filtra por fecha de creación.

Campos de respuesta

Campo Filtrable Descripción
id, name Sí ID y nombre del programa.
percent, amount, currency Sí La tasa de comisión — percent para variable, amount/currency para fija.
status Sí Estado del programa.
commissionType Sí variable o fixed.
conversionEventId Sí El tipo de evento por el que este programa paga comisión.
commissionShort — Comisión en formato legible, p. ej. "15%" o "30 EUR".
commissionValue, commissionUnit — El valor numérico de la comisión y su unidad (% o código de moneda).
commission — Forma legible más extensa, p. ej. "Fixed (30 EUR)".
tieredCommissionModel, tieredCommissionStartDate Sí Modelo por niveles y cuándo entra en vigor, si es escalonado.
channelId — Solo definido para programas exclusivos de canal.
markets — Array de códigos de mercado a los que aplica el programa.
tiers — Solo para programas escalonados. Cada nivel tiene transactions, value, amount/currency, commissionShort, transactionsText.
rules — Solo cuando se han configurado reglas de comisión condicionales en el programa.

Relaciones

GET /relations

Accesible para

Todos los tipos de cuenta, limitados a sus propias relaciones como es habitual — no hay diferencia de comportamiento entre tipos de cuenta más allá de eso.

Parámetros de solicitud

Parámetro Descripción
fromDate, toDate Opcional. Filtra por fecha de creación.
updatedFromDate, updatedToDate Opcional. Filtra por la fecha en que se actualizó la relación por última vez.

Campos de respuesta

Campo Filtrable Descripción
id Sí ID de la relación.
advertiserId Sí El lado de la relación correspondiente al anunciante.
advertiserName — El nombre público del anunciante.
channelId Sí El lado de la relación correspondiente al canal.
channelName, channelType, channelCategory — El nombre, tipo y categoría del canal.
created, updated Sí Cuándo se creó la relación y cuándo se actualizó por última vez.
status Sí Estado de la relación, p. ej. active.
noticeDate, noticeDays Sí Período de preaviso, si la relación está siendo terminada.
endedDate, endedReason Sí Cuándo y por qué terminó la relación, si corresponde.
activatedDate Sí Cuándo se activó la relación.
trackingLink — El enlace de seguimiento de su canal para este anunciante.
programs — Array de programas de comisión disponibles en esta relación — mismos campos que el endpoint de Programas anterior, más individualCommission: true cuando este canal tiene su propia comisión personalizada para ese programa (en cuyo caso percent/amount ya reflejan dicha personalización).

Estadísticas

GET /stats

Accesible para

Todos los tipos de cuenta. Las cuentas de anunciante y agencia reciben además campos de comisión de intermediación (brokerageFee, totalBrokerageFee, deniedBrokerageFee, denialRateBrokerageFee) en la respuesta; estos no se incluyen para las cuentas de afiliado, ya que la comisión de intermediación es el margen de la plataforma sobre la comisión del afiliado.

Parámetros de solicitud

Parámetro Descripción
groupBy Opcional. Agrega la respuesta por una o más dimensiones: date, advertiser, channel, y/o program. Si se omite, la respuesta es un único total agregado. Combine varias dimensiones con una coma, p. ej. groupBy=date,channel.
currency Opcional. Un código de moneda de 3 letras al que convertir los campos monetarios. Por defecto, la moneda de su cuenta.
advertiserId, channelId, programId, market Opcional. Filtra la agregación a un anunciante, canal, programa y/o mercado específico.
fromDate, toDate Opcional. Filtra por fecha — este endpoint agrega por date, no por created.

Campos de respuesta

Campo Descripción
advertiserId/advertiserName, channelId/channelName, programId/programName, affiliateId, market Solo se incluyen para las dimensiones por las que agrupó.
date/week/month/quarter/year Solo se incluyen cuando agrupó por date.
clicks, impressions Recuento de clics e impresiones.
transactions, transactionsInclClick Recuento de transacciones, con y sin incluir las conversiones de solo clic.
sales Valor total de ventas.
commission Comisión total.
deniedTransactions, deniedCommission Recuento y comisión de transacciones denegadas.
totalTransactions Recuento total de transacciones, incluidas las denegadas.
uniqueAdvertisersWithClicks/uniqueChannelsWithClicks/uniqueMarketsWithClicks Recuentos distintos en los clics de este grupo.
uniqueAdvertisersWithTransactions/uniqueChannelsWithTransactions/uniqueMarketsWithTransactions Recuentos distintos en las transacciones de este grupo.
uniqueMarketsWithClicksGroup Los códigos de mercado concretos observados, como una cadena de texto.
epc Ganancias por clic.
cr Tasa de conversión.
aov Valor medio del pedido.
currency Moneda de los campos monetarios.

Este endpoint devuelve estadísticas preagregadas en lugar de registros individuales, por lo que sus campos no son filtrables de la misma manera, campo por campo, que en otros endpoints — utilice en su lugar los parámetros de solicitud anteriores.

Errores de seguimiento

GET /trackingErrors

Accesible para

Todos los tipos de cuenta, limitados a su(s) propio(s) anunciante(s)/canal(es) como es habitual — no hay diferencia de comportamiento entre tipos de cuenta más allá de eso.

Parámetros de solicitud

Parámetro Descripción
fromDate, toDate Opcional. Filtra por fecha.

Campos de respuesta

Campo Filtrable Descripción
id Sí ID del error de seguimiento.
date Sí Cuándo ocurrió el error.
channelId, advertiserId Sí El canal y el anunciante involucrados.
redirectUrl Sí La URL a la que el clic intentó redirigir, si corresponde.
clickUrl Sí La URL de seguimiento que se llamó.
message Sí Descripción de lo que salió mal.
referrer Sí Referente HTTP.

Transacciones

GET /transactions

Accesible para

Todos los tipos de cuenta. Las cuentas de anunciante y agencia reciben además campos de comisión de intermediación (brokerageMarkup, brokerageFee, deniedBrokerageFee, originalBrokerageFee) en la respuesta; estos no se incluyen para las cuentas de afiliado.

Parámetros de solicitud

Parámetro Descripción
includeClicks Opcional. Establézcalo en 1 para incluir un array con los clics que precedieron a cada transacción.
includeProducts Opcional. Establézcalo en 1 para incluir los productos de línea de cada transacción.
includeTransactionListStatus Opcional. Establézcalo en 1 para incluir el estado del lote de pago al que pertenece cada transacción.
orderBy Opcional. Orden de los resultados, p. ej. created DESC.
fromDate, toDate Opcional. Filtra por fecha de creación.
updatedFromDate, updatedToDate Opcional. Filtra por la fecha en que se actualizó la transacción por última vez.

Campos de respuesta

Campo Filtrable Descripción
id Sí ID de la transacción.
date, created, updated Sí Fecha de la transacción, marca de tiempo de creación y de última actualización.
channelId, advertiserId Sí El canal y el anunciante involucrados.
channelName, advertiserName — Sus nombres públicos.
programId Sí El programa de comisión aplicado.
programName Sí El nombre del programa de comisión.
eventId Sí El evento de seguimiento subyacente a partir del cual se creó esta transacción.
commissionType Sí variable o fixed.
commissionPercent, commissionAmount Sí La tasa aplicada, según commissionType.
eventValue, currency Sí Valor del pedido y moneda.
conversionEventId Sí El tipo de evento de conversión, p. ej. Purchase.
status Sí new, approved, denied, delayed, o paidOut.
eventOrderId Sí El ID de pedido propio del anunciante.
payoutId Sí El pago en el que se incluyó esta transacción, una vez pagada.
transactionListId Sí El lote de pago al que pertenece esta transacción.
transactionListStatus — Solo con includeTransactionListStatus. Estado de ese lote de pago.
clickRef, clickId Sí Referencias al clic de origen.
clickDate/clicks — Solo con includeClicks. El/los clic(s) que precedieron a esta transacción.
products — Solo con includeProducts. Productos de línea — cada uno con id, product_id, title, category, brand, quantity, price, total.
denyReason, denyReasonCategory, denyDate Sí Se establece cuando se deniega la transacción.
market Sí Código de mercado.
discountCodes Sí Código(s) de descuento utilizados en el pedido, si se rastrean.
affiliateGclid, wctid Sí IDs de clic de Google Ads / otras plataformas publicitarias, si están presentes.
untrackedSale Sí Si se añadió manualmente como una venta no rastreada.
clickCount Sí Número de clics asociados a esta transacción.
individualCommissionId Sí Se establece cuando se aplicó una comisión personalizada específica del canal.
commissionSource Sí De dónde proviene la comisión, p. ej. program, individualCommission.
delayedUntil Sí Fecha hasta la que se retiene la transacción, si está retrasada.
subids Sí Sus propios parámetros de sub-ID, si se enviaron.
source Sí Origen de la transacción.
commission, commissionText — Importe de comisión calculado y su forma legible.
originalCommission — Comisión antes de cualquier ajuste.
currencies — Objeto indexado por código de moneda, cada uno con rate, commission, eventValue, originalCommission — una vista de la misma transacción convertida a esa moneda.

Actualizar el estado de una transacción

PATCH /transactions/status/{id}

Accesible para

Solo anunciantes.

Actualiza el estado de una transacción. La respuesta contiene la transacción actualizada, con la misma estructura que la anterior.

Cuerpo de la solicitud

{ "status": "approved" }

También puede buscar una transacción por su propio ID de pedido en lugar de su ID de transacción de Addrevenue — omita {id} de la ruta y envíe { "orderId": "your-order-id", "status": "approved" }.

Valores de status aceptados: new, approved, denied, delayed. Una transacción ya no se puede modificar una vez que se ha incluido en un lote de pago que ha salido del estado pendiente.

Registro de cambios

2026-09-02: Se amplió la referencia de la API para documentar todos los endpoints disponibles y sus parámetros completos de solicitud y respuesta.

2026-08-04: Se corrigió GET /products para que las cuentas distintas del propio anunciante ya no vean productos de anunciantes cuyo mercado no esté activo.

2026-07-28: Se añadió el parámetro de solicitud includeProducts a GET /transactions.

2026-07-16: Se corrigió un fallo en GET /relations por el que ocasionalmente se incluían programas exclusivos de canal que no aplicaban al canal indicado.

2026-06-25: Se corrigió la precisión de detectedCurrency/detectedLanguage en GET /productfeeds. GET /products ahora incluye min_handling_time/max_handling_time cuando el anunciante ha configurado un valor de respaldo.

2026-06-02: Se corrigió el enlace de paginación links.prev, que podía aparecer incorrectamente en la primera página de resultados.

2026-05-15: Se añadieron los campos detectedCurrency y detectedLanguage a la respuesta de GET /productfeeds.

2026-04-28: Se añadió el endpoint GET /brokenLinks.

2026-04-07: Se añadió el campo landingPages a la respuesta de GET /advertisers (disponible con expand=1).

2026-03-06: Se añadió el campo conversionEventId a la respuesta de GET /programs.

2026-01-25: Se corrigieron los parámetros de solicitud updatedFromDate/updatedToDate, que antes no se aplicaban debido a un error interno de nomenclatura.

2024-09-18: Se cambiaron los nombres de los parámetros de paginación de productsPerPage y selectedPage a limit y offset.

2022-05-12: Se añadió el nuevo endpoint /payouts para que los afiliados puedan consultar todos sus pagos.

2022-04-28: Se añadió el nuevo endpoint /productfeeds para que los afiliados puedan consultar una lista de todas las URLs de feeds de productos.

2022-04-27: Se añadió el nuevo endpoint /relations para listar sus relaciones entre canales y anunciantes.

2022-04-22: Se añadió la posibilidad de agrupar /stats por varias dimensiones.

2022-04-21: Se añadió channelId como parámetro de solicitud al endpoint /advertisers, para limitar la respuesta a los anunciantes con relaciones con el canal indicado.

2022-04-20: Se añadió el endpoint /stats para obtener estadísticas agregadas.

2022-04-19: Se añadió la posibilidad de limitar las respuestas de ciertos endpoints, como transactions y events, mediante los parámetros de consulta fromDate y/o toDate.

2022-03-22: Al enviar channelId al endpoint /campaigns, ahora solo se muestran las campañas de anunciantes con una relación aprobada con el canal.

2022-03-19: Se añadió el parámetro de solicitud includeClicks al endpoint /transactions, para incluir todos los clics precedentes en un array.

2022-03-18: Se añadió trackingLink en la respuesta del endpoint /campaigns, si se proporciona el parámetro channelId.

2022-03-18: Se añadió advertiserName en la respuesta del endpoint /campaigns.

2022-03-18: Se añadió advertiserName en la respuesta del endpoint /banners.

×

Crear una cuenta

Elige el tipo de cuenta que mejor se adapte a tu perfil