Descripción del informe de suscripciones
10 min de lectura
Descripción del informe de suscripciones
El 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.
Puedes generar el informe utilizando el endpoint Generate report.
Existen los siguientes tipos de informes:
- Suscripciones con status
- Suscripciones programadas entre fechas
- Suscripciones actualizadas entre fechas
- Suscripciones creadas entre fechas
- Suscripciones ejecutadas entre fechas
También puedes usar el endpoint <a href=https://developers.vtex.com/docs/api-reference/subscriptions-api-v3#get-/api/rns/pvt/reports>List report templates para conocer los tipos de informe que puedes generar.
Este artículo presenta los diferentes datos que devuelve cada tipo de informe de suscripciones.
Suscripciones con status
El informe subscriptionsWithStatus devuelve datos de suscripciones basados en el status de la ejecución del ciclo.
Las columnas corresponden a información específica sobre la suscripción, conforme se describe a continuación.
| Nombre del campo | Descripción |
|---|---|
| ID | ID de la suscripción. |
| Customer Email | Email del cliente. |
| Customer Id | ID del cliente. |
| Status | Status de la suscripción en el momento de generar el informe. TRIGGERED: se activó una ejecución del ciclo de la suscripción. IN_PROCESS: la suscripción está siendo procesada por el sistema (status temporal). FAILURE: se produjo un error interno al ejecutar la suscripción. SUCCESS: el ciclo de suscripción se procesó con éxito. EXPIRED: la suscripción no se renovó y se superó la fecha límite vigente. ORDER_ERROR: el ciclo de la suscripción no se ejecutó debido a un error en el place order del pedido. PAYMENT_ERROR: el ciclo de suscripción no se ejecutó debido a un error en el pago. SKIPED: se omitió la ejecución de un ciclo de suscripción y esta se ejecutará en el siguiente ciclo. SUCCESS_WITH_NO_ORDER: un ciclo de suscripción se ejecutó con éxito y el pedido vinculado no contiene ítems. SUCCESS_WITH_PARTIAL_ORDER: un ciclo de suscripción se ejecutó con éxito y tiene un pedido parcial vinculado. RE_TRIGGERED: se activó manualmente una reejecución del ciclo de suscripción. SCHEDULE_UPDATED: la fecha de la próxima ejecución del ciclo de la suscripción fue actualizada. |
| Has Active Items | informa si la suscripción contiene ítems activos. TRUE: contiene ítems activos. "FALSE": no contiene ítems activos. |
| Is Skipped | Indica si se omitirá el ciclo de la suscripción. TRUE: el ciclo se omitirá. FALSE: el ciclo no se omitirá. |
| Next Purchase Date | Fecha de la próxima compra. |
| Last Purchase Date | Fecha de la última compra. |
| Periodicity | Periodicidad de la suscripción. |
| Interval | Intervalo de la suscripción. |
| Purchase Day | Día de compra de la suscripción. |
| AddressId | ID de la dirección del cliente. |
| AddressType | Tipo de dirección. |
| PaymentSystem Name | Tipo de pago de la suscripción. |
| Account Id | ID de la cuenta. |
| Selected Sla | Service Level Agreement (SLA)](https://vtex.com/co-es/privacy-and-agreements/agreements/) elegido. |
| Cycle | Número que identifica el ciclo de la suscripción. |
| Created At | Fecha de creación de la suscripción. |
| Last Update | Última actualización de la suscripción. |
| Subscriptions Items Count | Recuento de ítems de la suscripción. |
| Subscriptions Item Id | ID de los ítems de la suscripción. |
| Subscriptions Item Status | Status de los ítems de la suscripción. |
| Subscriptions Item Sku Id | SKUs de los ítems de la suscripción. |
| Subscriptions Item PriceAtSubscriptionDate | Valor de los ítems en el momento de la suscripción. |
| Subscriptions Item Quantity | Cantidad de ítems de la suscripción. |
| Subscriptions Item Is Skipped | Informa si se omitirán ítems de la suscripción. TRUE: los ítems se omitirán. FALSE: los ítems no se omitirán. |
| Subscriptions Item Cycle | Ciclo de los ítems de la suscripción. |
| Subscriptions Item OriginalOrder | Pedido original de los ítems de la suscripción. |
Suscripciones programadas entre fechas
El informe subscriptionsScheduledBetweenDate devuelve datos de suscripciones programadas entre un rango de fechas.
Las columnas corresponden a información específica sobre la suscripción, conforme se describe a continuación.
| Nombre del campo | Descripción |
|---|---|
| ID | ID de la suscripción. |
| Customer Email | Email del cliente. |
| Customer Id | ID del cliente. |
| Status | Status de la suscripción en el momento de generar el informe. TRIGGERED: se activó una ejecución del ciclo de suscripción. IN_PROCESS: la suscripción está siendo procesada por el sistema (status temporal). FAILURE: se produjo un error interno al ejecutar la suscripción. SUCCESS: el ciclo de suscripción se procesó con éxito. EXPIRED: la suscripción no se renovó y se superó la fecha límite vigente. ORDER_ERROR: el ciclo de la suscripción no se ejecutó debido a un error en el place order del pedido. PAYMENT_ERROR: el ciclo de suscripción no se ejecutó debido a un error en el pago. SKIPED: se omitió la ejecución de un ciclo de suscripción y se ejecutará en el siguiente ciclo. SUCCESS_WITH_NO_ORDER: un ciclo de suscripción se ejecutó con éxito y el pedido vinculado no contiene ítems. SUCCESS_WITH_PARTIAL_ORDER: un ciclo de suscripción se ejecutó con éxito y contiene un pedido parcial vinculado. RE_TRIGGERED: se activó manualmente una reejecución del ciclo de suscripción. SCHEDULE_UPDATED: se actualizó la fecha de la próxima ejecución del ciclo de la suscripción. |
| Has Active Items | informa si la suscripción contiene ítems activos. TRUE: contiene ítems activos. "FALSE": no contiene ítems activos. |
| Is Skipped | Indica si se omitirá el ciclo de la suscripción. TRUE: el ciclo se omitirá. FALSE: el ciclo no se omitirá. |
| Next Purchase Date | Fecha de la próxima compra. |
| Last Purchase Date | Fecha de la última compra. |
| Periodicity | Periodicidad de la suscripción. |
| Interval | Intervalo de la suscripción. |
| Purchase Day | Día de compra de la suscripción. |
| AddressId | ID de la dirección del cliente. |
| AddressType | Tipo de dirección. |
| PaymentSystem Name | Tipo de pago de la suscripción. |
| Account Id | ID de la cuenta. |
| Selected Sla | Service Level Agreement (SLA)](https://vtex.com/co-es/privacy-and-agreements/agreements/) elegido. |
| Cycle | Número que identifica el ciclo de la suscripción. |
| Created At | Fecha de creación de la suscripción. |
| Last Update | Última actualización de la suscripción. |
| Subscriptions Items Count | Recuento de ítems de la suscripción. |
| Subscriptions Item Id | ID de los ítems de la suscripción. |
| Subscriptions Item Status | Status de los ítems de la suscripción. |
| Subscriptions Item Sku Id | SKUs de los ítems de la suscripción. |
| Subscriptions Item PriceAtSubscriptionDate | Valor de los ítems en el momento de la suscripción. |
| Subscriptions Item Quantity | Cantidad de ítems de la suscripción. |
| Subscriptions Item Is Skipped | Informa si se omitirán los ítems de la suscripción. TRUE: los ítems se omitirán. FALSE: los ítems no se omitirán. |
| Subscriptions Item Cycle | Ciclo de los ítems de la suscripción. |
| Subscriptions Item OriginalOrder | Pedido original de los ítems de la suscripción. |
Suscripciones actualizadas entre fechas
El informe subscriptionsUpdatedBetweenDate devuelve datos de las suscripciones actualizadas entre un rango de fechas.
Las columnas corresponden a información específica sobre la suscripción, conforme se describe a continuación.
| Nombre del campo | Descripción |
|---|---|
| ID | ID de la suscripción. |
| Customer Email | Email del cliente. |
| Customer Id | ID del cliente. |
| Status | Status de la suscripción en el momento de generar el informe. TRIGGERED: se activó una ejecución del ciclo de suscripción. IN_PROCESS: la suscripción está siendo procesada por el sistema (status temporal). FAILURE: se produjo un error interno al ejecutar la suscripción. SUCCESS: el ciclo de suscripción se procesó con éxito. EXPIRED: la suscripción no se renovó y se superó la fecha límite vigente. ORDER_ERROR: el ciclo de suscripción no se ejecutó debido a un error en el place order del pedido. PAYMENT_ERROR: el ciclo de suscripción no se ejecutó debido a un error en el pago. SKIPED: se omitió la ejecución de un ciclo de suscripción y se ejecutará en el siguiente ciclo. SUCCESS_WITH_NO_ORDER: un ciclo de suscripción se ejecutó con éxito y el pedido vinculado no contiene ítems. SUCCESS_WITH_PARTIAL_ORDER: un ciclo de suscripción se ejecutó con éxito y contiene un pedido parcial vinculado. RE_TRIGGERED: se activó manualmente una reejecución del ciclo de suscripción. SCHEDULE_UPDATED: se actualizó la fecha de la próxima ejecución del ciclo de la suscripción. |
| Has Active Items | informa si la suscripción contiene ítems activos. TRUE: contiene ítems activos. "FALSE": no contiene ítems activos. |
| Is Skipped | Indica si se omitirá el ciclo de la suscripción. TRUE: el ciclo se omitirá. FALSE: el ciclo no se omitirá. |
| Next Purchase Date | Fecha de la próxima compra. |
| Last Purchase Date | Fecha de la última compra. |
| Periodicity | Periodicidad de la suscripción. |
| Interval | Intervalo de la suscripción. |
| Purchase Day | Día de compra de la suscripción. |
| AddressId | ID de la dirección del cliente. |
| AddressType | Tipo de dirección. |
| PaymentSystem Name | Tipo de pago de la suscripción. |
| Account Id | ID de la cuenta. |
| Selected Sla | Service Level Agreement (SLA)](https://vtex.com/co-es/privacy-and-agreements/agreements/) elegido. |
| Cycle | Número que identifica el ciclo de la suscripción. |
| Created At | Fecha de creación de la suscripción. |
| Last Update | Última actualización de la suscripción. |
| Subscriptions Items Count | Recuento de ítems de la suscripción. |
| Subscriptions Item Id | ID de los ítems de la suscripción. |
| Subscriptions Item Status | Status de los ítems de la suscripción. |
| Subscriptions Item Sku Id | SKUs de los ítems de la suscripción. |
| Subscriptions Item PriceAtSubscriptionDate | Valor de los ítems en el momento de la suscripción. |
| Subscriptions Item Quantity | Cantidad de ítems de la suscripción. |
| Subscriptions Item Is Skipped | Informa si se omitirán los ítems de la suscripción. TRUE: los ítems se omitirán. FALSE: los ítems no se omitirán. |
| Subscriptions Item Cycle | Ciclo de los ítems de la suscripción. |
| Subscriptions Item OriginalOrder | Pedido original de los ítems de la suscripción. |
Suscripciones creadas entre fechas
El informe subscriptionsCreatedBetweenDate devuelve datos de las suscripciones creadas entre un rango de fechas.
Las columnas corresponden a información específica sobre la suscripción, conforme se describe a continuación.
| Nombre del campo | Descripción |
|---|---|
| ID | ID de la suscripción. |
| Customer Email | Email del cliente. |
| Customer Id | ID del cliente. |
| Status | Status de la suscripción en el momento de generar el informe. TRIGGERED: se activó una ejecución del ciclo de suscripción. IN_PROCESS: la suscripción está siendo procesada por el sistema (status temporal). FAILURE: se produjo un error interno al ejecutar la suscripción. SUCCESS: el ciclo de suscripción se procesó con éxito. EXPIRED: la suscripción no se renovó y superó la fecha límite vigente. ORDER_ERROR: el ciclo de la suscripción no se ejecutó debido a un error en el place order del pedido. PAYMENT_ERROR: el ciclo de suscripción no se ejecutó debido a un error en el pago. SKIPED: se omitió la ejecución de un ciclo de suscripción y se ejecutará en el siguiente ciclo. SUCCESS_WITH_NO_ORDER: un ciclo de suscripción se ejecutó con éxito y el pedido vinculado no contiene ítems. SUCCESS_WITH_PARTIAL_ORDER: un ciclo de suscripción se ejecutó con éxito y contiene un pedido parcial vinculado. RE_TRIGGERED: se activó manualmente una reejecución del ciclo de suscripción. SCHEDULE_UPDATED: se actualizó la fecha de la próxima ejecución del ciclo de la suscripción. |
| Has Active Items | informa si la suscripción contiene ítems activos. TRUE: contiene ítems activos. "FALSE": no contiene ítems activos. |
| Is Skipped | Indica si se omitirá el ciclo de la suscripción. TRUE: el ciclo se omitirá. FALSE: el ciclo no se omitirá. |
| Next Purchase Date | Fecha de la próxima compra. |
| Last Purchase Date | Fecha de la última compra. |
| Periodicity | Periodicidad de la suscripción. |
| Interval | Intervalo de la suscripción. |
| Purchase Day | Día de compra de la suscripción. |
| AddressId | ID de la dirección del cliente. |
| AddressType | Tipo de dirección. |
| PaymentSystem Name | Tipo de pago de la suscripción. |
| Account Id | ID de la cuenta. |
| Selected Sla | Service Level Agreement (SLA)](https://vtex.com/co-es/privacy-and-agreements/agreements/) elegido. |
| Cycle | Número que identifica el ciclo de la suscripción. |
| Created At | Fecha de creación de la suscripción. |
| Last Update | Última actualización de la suscripción. |
| Subscriptions Items Count | Recuento de ítems de la suscripción. |
| Subscriptions Item Id | ID de los ítems de la suscripción. |
| Subscriptions Item Status | Status de los ítems de la suscripción. |
| Subscriptions Item Sku Id | SKUs de los ítems de la suscripción. |
| Subscriptions Item PriceAtSubscriptionDate | Valor de los ítems en el momento de la suscripción. |
| Subscriptions Item Quantity | Cantidad de ítems de la suscripción. |
| Subscriptions Item Is Skipped | Informa si se omitirán los ítems de la suscripción. TRUE: los ítems se omitirán. FALSE: los ítems no se omitirán. |
| Subscriptions Item Cycle | Ciclo de los ítems de la suscripción. |
| Subscriptions Item OriginalOrder | Pedido original de los ítems de la suscripción. |
Suscripciones ejecutadas entre fechas
El informe executionsBetweenDate devuelve datos de las suscripciones ejecutadas entre un rango de fechas.
Las columnas corresponden a información específica sobre la suscripción, conforme se describe a continuación.
| Nombre del campo | Descripción |
|---|---|
| Id | ID de la suscripción. |
| OrderGroup | ID del pedido generado al ejecutar el informe. |
| Email del cliente. | |
| Customer Id | ID del cliente. |
| Skus | SKUs de los productos de la suscripción. |
| Order | Número de pedido. |
| Value | Valor de la suscripción. |
| cycleCount | Número que identifica el ciclo de la suscripción. |
| date | Fecha de creación de la suscripción. |
| IsInRetry | Informa si la ejecución fue resultado de un reintento. TRUE: La ejecución es resultado de un reintento. FALSE: La ejecución no es resultado de un reintento. |
| Status | Status de la suscripción en el momento de generar el informe. TRIGGERED: se activó una ejecución del ciclo de suscripción. IN_PROCESS: la suscripción está siendo procesada por el sistema (status temporal). FAILURE: se produjo un error interno al ejecutar la suscripción. SUCCESS: el ciclo de suscripción se procesó con éxito. EXPIRED: la suscripción no se renovó y se superó la fecha límite vigente. ORDER_ERROR: el ciclo de la suscripción no se ejecutó debido a un error en el place order del pedido. PAYMENT_ERROR: el ciclo de suscripción no se ejecutó debido a un error en el pago. SKIPED: se omitió la ejecución de un ciclo de suscripción y se ejecutará en el siguiente ciclo. SUCCESS_WITH_NO_ORDER: un ciclo de suscripción se ejecutó con éxito y el pedido vinculado no contiene ítems. SUCCESS_WITH_PARTIAL_ORDER: un ciclo de suscripción se ejecutó con éxito y contiene un pedido parcial vinculado. RE_TRIGGERED: se activó manualmente una reejecución del ciclo de la suscripción. SCHEDULE_UPDATED: se actualizó la fecha de la próxima ejecución del ciclo de la suscripción. |
| messageParsed | Mensaje devuelto por el checkout durante la ejecución de la suscripción. |
| CreatedAt | Fecha de creación de la suscripción. |
| LastUpdate | Fecha de la última actualización de la suscripción. |
| ActiveSkus | SKUs activos en la suscripción. |