Listado de ventas

Este método permite obtener el listado de ventas.

Método de acceso

GET /Sale

Estructura de la petición

Requiere pasarle, como parámetro de la url (query string), los siguientes parámetros: Filtros disponibles para la obtención del listado de ventas. Estos filtros se envían como parámetros en la URL (query string). Filtros disponibles:

• PartnerSaleId: (string). Opcional Identificador del colaborador.
• FromTransactionDateTime: (date). Opcional Fecha inicial de creación de la transacción. Formato IS0 8601 (YYYY-MM-DD).
• ToTransactionDateTime: (date). Opcional Fecha final de creación de la transacción. Formato IS0 8601 (YYYY-MM-DD).
• FromAccessDateTime: (date). Opcional Fecha inicial de acceso. Formato IS0 8601 (YYYY-MM-DD).
• ToAccessDateTime: (date). Opcional Fecha final de acceso. Formato IS0 8601 (YYYY-MM-DD).
• ClientName: (string). Opcional Nombre del cliente.
• ClientEmail: (string). Opcional Email del cliente.
• ClientPhone: (string). Opcional Teléfono del cliente.
• ClientDocumentIdentifier: (string). Opcional Documento de identidad del cliente.
• Page: (int). Opcional Número de página a obtener. Valor por defecto 1.
• PageSize: (int). Opcional Número de resultados a obtener.

Ejemplo de llamada

Examples

{{url}}/Sale?PartnerSaleId=MyPartnerSaleId&FromTransactionDateTime=2022-10-07&Page=1&ClientName=MyClientName

Estructura de la respuesta

• Sales: (list). Listado de ventas.

  • PartnerSaleId: (string). Identificador del colaborador.
  • Activities: (list). Listado de actividades.
    • Anexo: Actividad
  • Accommodations: (list). Listado de alojamientos incluidos en la venta.
    • Anexo: Alojamiento
  • CombinedProducts: (list). Listado de productos combinados de las actividades incluidos en la venta.
    • Anexo: Producto Combinado
  • Client: (object). Datos del cliente de la venta.
    • Anexo: Cliente
  • TotalPrice: (decimal). Indica el precio total de la venta.
  • TotalPriceWithoutVat: (decimal). Indica el precio total de la venta sin impuestos.
  • TotalDiscount: (decimal). Descuento total aplicado sobre la venta. Solo aparece si se ha aplicado algún cupón descuento.
  • InsurancePolicyAmount: (decimal). Indica el precio total del seguro de reembolso.
  • InsurancePolicyAmountWithoutTaxes: (decimal). Indica el precio total del seguro de reembolso sin impuestos.

• 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

{
    "Sales": [
        {
            "PartnerSaleId": "i6m7uj93p1mie",
            "TotalPrice": 22.36,
            "TotalPriceWithoutVat": 18.48,
            "TotalDiscount": 0.0,
            "Client": {
                "CreatedDate": "2024-07-26T11:41:34.453",
                "FullName": "Experticket Team",
                "Surname": "Team",
                "Email": "tecnologia@experticket.com",
                "PhoneNumber": "666666666",
                "CountryCode": "es",
                "LanguageCode": "es",
                "Gender": 0,
                "AcceptsEmailContact": false,
                "AllowCustomerProfiling": false,
                "Success": false,
                "Timestamp": "0001-01-01T00:00:00"
            },
            "Activities": [
                {
                    "FinancialRatios": {
                        "ReferenceSalePrice": {
                            "BasePrice": 18.48,
                            "Quota": 3.88,
                            "Total": 22.36
                        },
                        "Discount": {
                            "BasePrice": 0.00,
                            "Quota": 0.0,
                            "Total": 0.0
                        },
                        "Commission": {
                            "BasePrice": 2.22,
                            "Quota": 0.47,
                            "Total": 2.68
                        },
                        "SalePrice": {
                            "BasePrice": 18.48,
                            "Quota": 3.88,
                            "Total": 22.36
                        }
                    },
                    "ProductId": "c88r4zkwdocqy",
                    "Tickets": [
                        {
                            "TicketId": "b3ziixhux5tq6",
                            "AccessCode": "NOTVALIDhkz4d6nyef17y",
                            "BillingCode": "3/0/3rihi8om3z57e",
                            "TicketName": "Entrada Adulto",
                            "AccessDateTime": "2024-08-02T00:00:00",
                            "AccessEndDateTime": "2024-08-02T00:00:00",
                            "SuggestedAccessDateMessage": "2/8/2024",
                            "EnclosureId": "shcbo55y5am5c",
                            "EnclosureName": "Recinto 1"
                        }
                    ],
                    "ProviderId": "1tnsbzkpnoz1o",
                    "Status": 2,
                    "PurchaseFlowType": 1,
                    "ProductName": "Entrada parque",
                    "ProviderName": "Parque",
                    "Price": 22.360000000000,
                    "PriceWithoutVat": 18.48,
                    "AccessDateTime": "2024-08-02T00:00:00",
                    "PriceMode": 1,
                    "AccessDateCriteria": 0,
                    "SalesDocumentSettings": {
                        "ShowPrice": true
                    },
                    "CancellationConditions": {
                        "IsRefundable": true,
                        "Rules": [
                            {
                                "HoursInAdvanceOfAccess": 96.00,
                                "Percentage": 100.00,
                                "Amount": 22.36,
                                "FromInclusiveDateTime": "2024-07-29T00:00:00"
                            }
                        ]
                    },
                    "PartnerCode": "u6bsdoty1zzar",
                    "ProviderType": 0
                }
            ],
            "PointOfSaleCustomCodes": [],
            "EconomicMovementAmount": 0.00,
            "EconomicMovementAmountWithoutTax": 0.0,
            "InsurancePolicyAmount": 0.00,
            "InsurancePolicyAmountWithoutTax": 0.0
        }
    ],
    "PageNumber": 1,
    "HasPreviousPage": false,
    "HasNextPage": false,
    "IsFirstPage": true,
    "Success": true
}