{"section":"tutorials","requestedLocale":"es","requestedSlug":"descripcion-del-informe-de-suscripciones","locale":"es","slug":"descripcion-del-informe-de-suscripciones","path":"docs/es/tutorials/suscripciones/descripcion-del-informe-de-suscripciones.md","branch":"main","content":"Descripción del informe de suscripciones\n\nEl informe de suscripciones es un documento en formato `.csv` con información sobre suscripciones, como fecha de creación, email del cliente, SKUs activos de la suscripción, entre otros datos.\n\nPuedes generar el informe utilizando el endpoint [Generate report](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3?endpoint=post-/api/rns/pvt/reports/-reportName-/documents).\n\nExisten los siguientes tipos de informes:\n\n- [Suscripciones con status](#suscripciones-con-status)\n- [Suscripciones programadas entre fechas](#suscripciones-programadas-entre-fechas)\n- [Suscripciones actualizadas entre fechas](#suscripciones-actualizadas-entre-fechas)\n- [Suscripciones creadas entre fechas](#suscripciones-creadas-entre-fechas)\n- [Suscripciones ejecutadas entre fechas](#suscripciones-ejecutadas-entre-fechas)\n\n> ℹ️ También puedes usar el endpoint [List report templates](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3#get-/api/rns/pvt/reports) para conocer los tipos de informe que puedes generar.\n\nEste artículo presenta los diferentes datos que devuelve cada tipo de informe de suscripciones.\n\n## Suscripciones con status\n\nEl informe `subscriptionsWithStatus` devuelve datos de suscripciones basados en el status de la ejecución del ciclo.\n\nLas columnas corresponden a información específica sobre la suscripción, conforme se describe a continuación.\n\n| **Nombre del campo** | **Descripción** |\n| :---: | :--- |\n| ID | ID de la suscripción. |\n| Customer Email | Email del cliente. |\n| Customer Id | ID del cliente. |\n| Status | Status de la suscripción en el momento de generar el informe. <br /> `TRIGGERED`: se activó una ejecución del ciclo de la suscripción. <br /> `IN_PROCESS`: la suscripción está siendo procesada por el sistema (status temporal). <br /> `FAILURE`: se produjo un error interno al ejecutar la suscripción. <br /> `SUCCESS`: el ciclo de suscripción se procesó con éxito. <br /> `EXPIRED`: la suscripción no se renovó y se superó la fecha límite vigente. <br /> `ORDER_ERROR`: el ciclo de la suscripción no se ejecutó debido a un error en el _place order_ del pedido. <br /> `PAYMENT_ERROR`: el ciclo de suscripción no se ejecutó debido a un error en el pago. <br /> `SKIPED` (escrito de esta manera): se omitió la ejecución de un ciclo de suscripción y esta se ejecutará en el siguiente ciclo. <br /> `SUCCESS_WITH_NO_ORDER`: un ciclo de suscripción se ejecutó con éxito y el pedido vinculado no contiene ítems. <br /> `SUCCESS_WITH_PARTIAL_ORDER`: un ciclo de suscripción se ejecutó con éxito y tiene un pedido parcial vinculado. <br /> `RE_TRIGGERED`: se activó manualmente una reejecución del ciclo de suscripción. <br /> `SCHEDULE_UPDATED`: la fecha de la próxima ejecución del ciclo de la suscripción fue actualizada. |\n| Has Active Items | informa si la suscripción contiene ítems activos. <br /> `TRUE`: contiene ítems activos. \"FALSE\": no contiene ítems activos. |\n| Is Skipped | Indica si se omitirá el ciclo de la suscripción. <br /> `TRUE`: el ciclo se omitirá. <br /> `FALSE`: el ciclo no se omitirá. |\n| Next Purchase Date | Fecha de la próxima compra. |\n| Last Purchase Date | Fecha de la última compra. |\n| Periodicity | Periodicidad de la suscripción. |\n| Interval | Intervalo de la suscripción. |\n| Purchase Day | Día de compra de la suscripción. |\n| AddressId | ID de la dirección del cliente. |\n| AddressType | Tipo de dirección. |\n| PaymentSystem Name | Tipo de pago de la suscripción. |\n| Account Id | ID de la cuenta. |\n| Selected Sla | [Service Level Agreement (SLA)](<https://vtex.com/co-es/trust/agreements>) elegido. |\n| Cycle | Número que identifica el ciclo de la suscripción. |\n| Created At | Fecha de creación de la suscripción. |\n| Last Update | Última actualización de la suscripción. |\n| Subscriptions Items Count | Recuento de ítems de la suscripción. |\n| Subscriptions Item Id | ID de los ítems de la suscripción. |\n| Subscriptions Item Status | Status de los ítems de la suscripción. |\n| Subscriptions Item Sku Id | SKUs de los ítems de la suscripción. |\n| Subscriptions Item PriceAtSubscriptionDate | Valor de los ítems en el momento de la suscripción. |\n| Subscriptions Item Quantity | Cantidad de ítems de la suscripción. |\n| Subscriptions Item Is Skipped | Informa si se omitirán ítems de la suscripción. <br /> `TRUE`: los ítems se omitirán. <br /> `FALSE`: los ítems no se omitirán. |\n| Subscriptions Item Cycle | Ciclo de los ítems de la suscripción. |\n| Subscriptions Item OriginalOrder | Pedido original de los ítems de la suscripción. |\n\n## Suscripciones programadas entre fechas\n\nEl informe `subscriptionsScheduledBetweenDate` devuelve datos de suscripciones programadas entre un rango de fechas.\n\nLas columnas corresponden a información específica sobre la suscripción, conforme se describe a continuación.\n\n| **Nombre del campo** | **Descripción** |\n| :---: | :--- |\n| ID | ID de la suscripción. |\n| Customer Email | Email del cliente. |\n| Customer Id | ID del cliente. |\n| Status | Status de la suscripción en el momento de generar el informe. <br /> `TRIGGERED`: se activó una ejecución del ciclo de suscripción. <br /> `IN_PROCESS`: la suscripción está siendo procesada por el sistema (status temporal). <br /> `FAILURE`: se produjo un error interno al ejecutar la suscripción. <br /> `SUCCESS`: el ciclo de suscripción se procesó con éxito. <br /> `EXPIRED`: la suscripción no se renovó y se superó la fecha límite vigente. <br /> `ORDER_ERROR`: el ciclo de la suscripción no se ejecutó debido a un error en el _place order_ del pedido. <br /> `PAYMENT_ERROR`: el ciclo de suscripción no se ejecutó debido a un error en el pago. <br /> `SKIPED` (escrito de esta manera): se omitió la ejecución de un ciclo de suscripción y se ejecutará en el siguiente ciclo. <br /> `SUCCESS_WITH_NO_ORDER`: un ciclo de suscripción se ejecutó con éxito y el pedido vinculado no contiene ítems. <br /> `SUCCESS_WITH_PARTIAL_ORDER`: un ciclo de suscripción se ejecutó con éxito y contiene un pedido parcial vinculado. <br /> `RE_TRIGGERED`: se activó manualmente una reejecución del ciclo de suscripción. <br /> `SCHEDULE_UPDATED`: se actualizó la fecha de la próxima ejecución del ciclo de la suscripción. |\n| Has Active Items | informa si la suscripción contiene ítems activos. <br /> `TRUE`: contiene ítems activos. <br /> `FALSE`: no contiene ítems activos. |\n| Is Skipped | Indica si se omitirá el ciclo de la suscripción. <br /> `TRUE`: el ciclo se omitirá. <br /> `FALSE`: el ciclo no se omitirá. |\n| Next Purchase Date | Fecha de la próxima compra. |\n| Last Purchase Date | Fecha de la última compra. |\n| Periodicity | Periodicidad de la suscripción. |\n| Interval | Intervalo de la suscripción. |\n| Purchase Day | Día de compra de la suscripción. |\n| AddressId | ID de la dirección del cliente. |\n| AddressType | Tipo de dirección. |\n| PaymentSystem Name | Tipo de pago de la suscripción. |\n| Account Id | ID de la cuenta. |\n| Selected Sla | [Service Level Agreement (SLA)](<https://vtex.com/co-es/trust/agreements>) elegido. |\n| Cycle | Número que identifica el ciclo de la suscripción. |\n| Created At | Fecha de creación de la suscripción. |\n| Last Update | Última actualización de la suscripción. |\n| Subscriptions Items Count | Recuento de ítems de la suscripción. |\n| Subscriptions Item Id | ID de los ítems de la suscripción. |\n| Subscriptions Item Status | Status de los ítems de la suscripción. |\n| Subscriptions Item Sku Id | SKUs de los ítems de la suscripción. |\n| Subscriptions Item PriceAtSubscriptionDate | Valor de los ítems en el momento de la suscripción. |\n| Subscriptions Item Quantity | Cantidad de ítems de la suscripción. |\n| Subscriptions Item Is Skipped | Informa si se omitirán los ítems de la suscripción. <br /> `TRUE`: los ítems se omitirán. <br /> `FALSE`: los ítems no se omitirán. |\n| Subscriptions Item Cycle | Ciclo de los ítems de la suscripción. |\n| Subscriptions Item OriginalOrder | Pedido original de los ítems de la suscripción. |\n\n## Suscripciones actualizadas entre fechas\n\nEl informe `subscriptionsUpdatedBetweenDate` devuelve datos de las suscripciones actualizadas entre un rango de fechas.\n\nLas columnas corresponden a información específica sobre la suscripción, conforme se describe a continuación.\n\n| **Nombre del campo** | **Descripción** |\n| :---: | :--- |\n| ID | ID de la suscripción. |\n| Customer Email | Email del cliente. |\n| Customer Id | ID del cliente. |\n| Status | Status de la suscripción en el momento de generar el informe. <br /> `TRIGGERED`: se activó una ejecución del ciclo de suscripción. <br /> `IN_PROCESS`: la suscripción está siendo procesada por el sistema (status temporal). <br /> `FAILURE`: se produjo un error interno al ejecutar la suscripción. `SUCCESS`: el ciclo de suscripción se procesó con éxito. <br /> `EXPIRED`: la suscripción no se renovó y se superó la fecha límite vigente. <br /> `ORDER_ERROR`: el ciclo de suscripción no se ejecutó debido a un error en el _place order_ del pedido. <br /> `PAYMENT_ERROR`: el ciclo de suscripción no se ejecutó debido a un error en el pago. <br /> `SKIPED` (escrito de esta manera): se omitió la ejecución de un ciclo de suscripción y se ejecutará en el siguiente ciclo. <br /> `SUCCESS_WITH_NO_ORDER`: un ciclo de suscripción se ejecutó con éxito y el pedido vinculado no contiene ítems. <br /> `SUCCESS_WITH_PARTIAL_ORDER`: un ciclo de suscripción se ejecutó con éxito y contiene un pedido parcial vinculado. <br /> `RE_TRIGGERED`: se activó manualmente una reejecución del ciclo de suscripción. <br /> `SCHEDULE_UPDATED`: se actualizó la fecha de la próxima ejecución del ciclo de la suscripción. |\n| Has Active Items | informa si la suscripción contiene ítems activos. <br /> `TRUE`: contiene ítems activos. <br /> `FALSE`: no contiene ítems activos. |\n| Is Skipped | Indica si se omitirá el ciclo de la suscripción. <br /> `TRUE`: el ciclo se omitirá. <br /> `FALSE`: el ciclo no se omitirá. |\n| Next Purchase Date | Fecha de la próxima compra. |\n| Last Purchase Date | Fecha de la última compra. |\n| Periodicity | Periodicidad de la suscripción. |\n| Interval | Intervalo de la suscripción. |\n| Purchase Day | Día de compra de la suscripción. |\n| AddressId | ID de la dirección del cliente. |\n| AddressType | Tipo de dirección. |\n| PaymentSystem Name | Tipo de pago de la suscripción. |\n| Account Id | ID de la cuenta. |\n| Selected Sla | [Service Level Agreement (SLA)](https://vtex.com/co-es/trust/agreements) elegido. |\n| Cycle | Número que identifica el ciclo de la suscripción. |\n| Created At | Fecha de creación de la suscripción. |\n| Last Update | Última actualización de la suscripción. |\n| Subscriptions Items Count | Recuento de ítems de la suscripción. |\n| Subscriptions Item Id | ID de los ítems de la suscripción. |\n| Subscriptions Item Status | Status de los ítems de la suscripción. |\n| Subscriptions Item Sku Id | SKUs de los ítems de la suscripción. |\n| Subscriptions Item PriceAtSubscriptionDate | Valor de los ítems en el momento de la suscripción. |\n| Subscriptions Item Quantity | Cantidad de ítems de la suscripción. |\n| Subscriptions Item Is Skipped | Informa si se omitirán los ítems de la suscripción. <br /> `TRUE`: los ítems se omitirán. <br /> `FALSE`: los ítems no se omitirán. |\n| Subscriptions Item Cycle | Ciclo de los ítems de la suscripción. |\n| Subscriptions Item OriginalOrder | Pedido original de los ítems de la suscripción. |\n\n## Suscripciones creadas entre fechas\n\nEl informe `subscriptionsCreatedBetweenDate` devuelve datos de las suscripciones creadas entre un rango de fechas.\n\nLas columnas corresponden a información específica sobre la suscripción, conforme se describe a continuación.\n\n| **Nombre del campo** | **Descripción** |\n| :---: | :--- |\n| ID | ID de la suscripción. |\n| Customer Email | Email del cliente. |\n| Customer Id | ID del cliente. |\n| Status | Status de la suscripción en el momento de generar el informe. <br /> `TRIGGERED`: se activó una ejecución del ciclo de suscripción. <br /> `IN_PROCESS`: la suscripción está siendo procesada por el sistema (status temporal). <br /> `FAILURE`: se produjo un error interno al ejecutar la suscripción. <br /> `SUCCESS`: el ciclo de suscripción se procesó con éxito. <br /> `EXPIRED`: la suscripción no se renovó y superó la fecha límite vigente. <br /> `ORDER_ERROR`: el ciclo de la suscripción no se ejecutó debido a un error en el _place order_ del pedido. <br /> `PAYMENT_ERROR`: el ciclo de suscripción no se ejecutó debido a un error en el pago. <br /> `SKIPED` (escrito de esta manera): se omitió la ejecución de un ciclo de suscripción y se ejecutará en el siguiente ciclo. <br /> `SUCCESS_WITH_NO_ORDER`: un ciclo de suscripción se ejecutó con éxito y el pedido vinculado no contiene ítems. <br /> `SUCCESS_WITH_PARTIAL_ORDER`: un ciclo de suscripción se ejecutó con éxito y contiene un pedido parcial vinculado. <br /> `RE_TRIGGERED`: se activó manualmente una reejecución del ciclo de suscripción. <br /> `SCHEDULE_UPDATED`: se actualizó la fecha de la próxima ejecución del ciclo de la suscripción. |\n| Has Active Items | informa si la suscripción contiene ítems activos. <br /> `TRUE`: contiene ítems activos. <br /> `FALSE`: no contiene ítems activos. |\n| Is Skipped | Indica si se omitirá el ciclo de la suscripción. <br /> `TRUE`: el ciclo se omitirá. <br /> `FALSE`: el ciclo no se omitirá. |\n| Next Purchase Date | Fecha de la próxima compra. |\n| Last Purchase Date | Fecha de la última compra. |\n| Periodicity | Periodicidad de la suscripción. |\n| Interval | Intervalo de la suscripción. |\n| Purchase Day | Día de compra de la suscripción. |\n| AddressId | ID de la dirección del cliente. |\n| AddressType | Tipo de dirección. |\n| PaymentSystem Name | Tipo de pago de la suscripción. |\n| Account Id | ID de la cuenta. |\n| Selected Sla | [Service Level Agreement (SLA)](https://vtex.com/co-es/trust/agreements) elegido. |\n| Cycle | Número que identifica el ciclo de la suscripción. |\n| Created At | Fecha de creación de la suscripción. |\n| Last Update | Última actualización de la suscripción. |\n| Subscriptions Items Count | Recuento de ítems de la suscripción. |\n| Subscriptions Item Id | ID de los ítems de la suscripción. |\n| Subscriptions Item Status | Status de los ítems de la suscripción. |\n| Subscriptions Item Sku Id | SKUs de los ítems de la suscripción. |\n| Subscriptions Item PriceAtSubscriptionDate | Valor de los ítems en el momento de la suscripción. |\n| Subscriptions Item Quantity | Cantidad de ítems de la suscripción. |\n| Subscriptions Item Is Skipped | Informa si se omitirán los ítems de la suscripción. <br /> `TRUE`: los ítems se omitirán. <br /> `FALSE`: los ítems no se omitirán. |\n| Subscriptions Item Cycle | Ciclo de los ítems de la suscripción. |\n| Subscriptions Item OriginalOrder | Pedido original de los ítems de la suscripción. |\n\n## Suscripciones ejecutadas entre fechas\n\nEl informe `executionsBetweenDate` devuelve datos de las suscripciones ejecutadas entre un rango de fechas.\n\nLas columnas corresponden a información específica sobre la suscripción, conforme se describe a continuación.\n\n| **Nombre del campo** | **Descripción** |\n| :---: | :--- |\n| Id | ID de la suscripción. |\n| OrderGroup | ID del pedido generado al ejecutar el informe. |\n| Email | Email del cliente. |\n| Customer Id | ID del cliente. |\n| Skus | SKUs de los productos de la suscripción. |\n| Order | Número de pedido. |\n| Value | Valor de la suscripción. |\n| cycleCount | Número que identifica el ciclo de la suscripción. |\n| date | Fecha de creación de la suscripción. |\n| IsInRetry | Informa si se puede realizar un nuevo intento o si el ciclo de la suscripción terminó. <br /> `TRUE`: la suscripción aún está en el ciclo de reintentos y hay intentos pendientes. <br /> `FALSE`: el ciclo de la suscripción terminó. |\n| Status | Status de la suscripción en el momento de generar el informe. <br /> `TRIGGERED`: se activó una ejecución del ciclo de suscripción. <br /> `IN_PROCESS`: la suscripción está siendo procesada por el sistema (status temporal). <br /> `FAILURE`: se produjo un error interno al ejecutar la suscripción. <br /> `SUCCESS`: el ciclo de suscripción se procesó con éxito. <br /> `EXPIRED`: la suscripción no se renovó y se superó la fecha límite vigente. <br /> `ORDER_ERROR`: el ciclo de la suscripción no se ejecutó debido a un error en el _place order_ del pedido. <br /> `PAYMENT_ERROR`: el ciclo de suscripción no se ejecutó debido a un error en el pago. <br /> `SKIPED` (escrito de esta manera): se omitió la ejecución de un ciclo de suscripción y se ejecutará en el siguiente ciclo. <br /> `SUCCESS_WITH_NO_ORDER`: un ciclo de suscripción se ejecutó con éxito y el pedido vinculado no contiene ítems. <br /> `SUCCESS_WITH_PARTIAL_ORDER`: un ciclo de suscripción se ejecutó con éxito y contiene un pedido parcial vinculado. <br /> `RE_TRIGGERED`: se activó manualmente una reejecución del ciclo de la suscripción. <br /> `SCHEDULE_UPDATED`: se actualizó la fecha de la próxima ejecución del ciclo de la suscripción. |\n| messageParsed | Mensaje devuelto por el checkout durante la ejecución de la suscripción. |\n| CreatedAt | Fecha de creación de la suscripción. |\n| LastUpdate | Fecha de la última actualización de la suscripción. |\n| ActiveSkus | SKUs activos en la suscripción. |"}