Saltar a contenido

Listado de solicitudes de cancelación

Este método permite crear una solicitud de cancelación para una venta.

Método de acceso

GET /salecancellationrequest

Estructura de la petición

  • PartnerSaleIds: (list) Requerido. Listado de identificadores del colaborador.
  • FromCreatedDateTime: (date). Opcional Fecha inicial de creación de la transacción. Formato IS0 8601 (YYYY-MM-DD).
  • ToCreatedDateTime: (date). Opcional Fecha final de creación de la transacción. Formato IS0 8601 (YYYY-MM-DD).
  • FromUpdatedDateTime: (date). Opcional Fecha inicial de acceso. Formato IS0 8601 (YYYY-MM-DD).
  • ToUpdatedDateTime: (date). Opcional Fecha final de acceso. Formato IS0 8601 (YYYY-MM-DD).
  • Page: (int). Opcional Número de página a obtener. Valor por defecto 1.

Ejemplo de llamada

Ejemplos

 Ejemplo de petición de JSON formateada:

{
    "PartnerSaleIds": ["stf9gy7i3xawa","iyh143uykd3qc"],
    "Page": 1
}

Estructura de la respuesta

  • Timestamp: (dateTime). Instante de tiempo en el que se procesó la petición. Formato ISO 8601 (yyyy-MM-ddThh:mm:ss.fffffff).

  • Sales: (list). Listado de ventas.

    • PartnerSaleId: (string). Listado de actividades.
    • CancellationRequests: (Objeto). Conceptos económicos de una venta.
    • ExperticketName: (string). Nombre de Experticket.
    • CancellationRequestId: (string). Identificador de la solicitud de cancelación.
    • SaleId: (Objeto). Identificador de la venta.
    • PartnerSaleId: (string). Identificador de la venta del colaborador.
    • CreatedDateTime: (date). Fecha de solicitud de cancelación.
    • UpdatedDateTime: (date). Fecha de solicitud de cancelación.

    • Status: (string). Estado de la cancelación.

      Posibles valores

       Aquí está la lista de estados de la solicitud de cancelación:

      • 0: Ninguno.
      • 1: En Proceso.
      • 2: Aceptada.
      • 3: Rechazada.
      • 3: Fallida.

    • StatusComments: (string). Comentarios del estado de la solicitud de cancelación.

    • Reason: (byte). Estado de la cancelación.

      Posibles valores

       Aquí está la lista de razones de la solicitud de cancelación:

      • 1: Cambio en fechas de acceso.
      • 2: Cambio de productos.
      • 3: Cambio en cantidad de asistentes.
      • 4: Enfermedad común.
      • 5: Gestión indebida de venta de entradas.
      • 6: Problemas con la integración.
      • 7: Error en el pago.

    • ReasonComments: (string). Comentarios del estado de la solicitud de cancelación.

    • PageNumber: (int). Indica la página solicitada.
    • HasPreviousPage: (boolean). Indica si hay una página previa a la solicitada.
    • HasNextPage: (boolean). Indica si hay una siguiente página.
    • IsFirstPage: (boolean). Indica si la página solicitada corresponde a la primera página

  • Success: (boolean). Valor que indica si la llamada ha sido procesada correctamente o no.

  • Errors: (list). Array de errores.
    • Error: (object).
      • ErrorMessage: (string). Mensaje de error explicando por qué la petición no ha sido correcta. En caso que haya sido correcta, devolverá null.
      • ErrorCode: (int). Código que identifica al error.
  • ErrorEntityBreakDown (list): Lista que contiene objetos con el nombre e ID en caso de error.
    • Id (string): Identificador
    • Name (string): Nombre relacionado del identificador.

Ejemplo de respuesta

Examples

 Ejemplo de respuesta JSON formateada:

{
    "CancellationRequests": [
        {
            "CancellationRequestId": "syw353uykd3qc",           
            "SaleId": "5056615501717130434",
            "PartnerSaleId": "stf9gy7i3xawa",
            "CreatedDateTime": "2001-01-05T18:57:00",
            "UpdatedDateTime": "2001-01-05T18:57:00",
            "Status": 1,
            "StatusComments": "",
            "Reason": 2,
            "ReasonComments": "",
        },
        {
            "CancellationRequestId": "1f48ahtxzphdg",           
            "SaleId": "5056615501717130434",
            "PartnerSaleId": "iyh143uykd3qc",
            "CreatedDateTime": "2001-01-05T15:57:00",
            "UpdatedDateTime": "2001-01-05T17:45:00",
            "Status": 2,
            "StatusComments": "",
            "Reason": 2,
            "ReasonComments": "",
        }
    ],
    "PageNumber": 1,
    "PageSize": 200,
    "HasPreviousPage": false,
    "HasNextPage": false,
    "IsFirstPage": true,
    "Success": true,
    "Timestamp": "2021-02-18T17:02:27.8165916",
    "ErrorEntityBreakDown": []
}