export interface Order { /** Unique order number. */ orderNumber?: string; /** Reservation ID. */ reservationId?: string; /** * Payment snapshot ID. Empty for the `FREE` order. * @readonly */ snapshotId?: string; /** Event ID to which the order belongs. */ eventId?: string; /** Contact ID of buyer (resolved using email address). */ contactId?: string; /** Buyer member ID, if applicable. */ memberId?: string; /** * RSVP created timestamp. * @readonly */ created?: Date | null; /** Guest first name. */ firstName?: string; /** Guest last name. */ lastName?: string; /** Guest email. */ email?: string; /** Checkout form response. When each purchased ticket is assigned to a guest, guest forms are returned for each ticket, and buyer info is returned. */ checkoutForm?: FormResponse; /** Whether the order is confirmed (triggered once payment gateway processes the payment and funds reach the merchant's account). */ confirmed?: boolean; /** * Order status. Possible values: * - `FREE`: The order is confirmed, no payment is required. * - `PENDING`: The order was paid, but the payment gateway suspended the payment. * - `PAID`: The order is paid. * - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`. * - `INITIATED`: The order is awaiting for payment. * - `CANCELED`: The order is canceled. * - `DECLINED`: The order is payment is declined. */ status?: OrderStatus; /** Payment method used for purchase, e.g., "payPal", "creditCard", etc. */ method?: string; /** Quantity of ordered tickets. */ ticketsQuantity?: number; /** Total order price. */ totalPrice?: Money; /** Ticket PDF URL. */ ticketsPdf?: string; /** Tickets (generated after payment). */ tickets?: TicketingTicket[]; /** Whether the order is archived. */ archived?: boolean; /** Whether the order is anonymized by GDPR delete. */ anonymized?: boolean; /** Guest full name. */ fullName?: string; /** Order invoice. */ invoice?: Invoice; /** Whether all tickets in order are checked-in. */ fullyCheckedIn?: boolean; /** Internal order payment details */ paymentDetails?: PaymentDetails; /** Checkout channel type */ channel?: ChannelType; /** * Order updated timestamp. * @readonly */ updated?: Date | null; /** Whether marketing consent was given */ marketingConsent?: boolean | null; } export interface FormResponse { /** Input fields for a checkout form. */ inputValues?: InputValue[]; } export interface InputValue { /** Input field name. */ inputName?: string; /** Input field value. */ value?: string; /** Multiple input field values. */ values?: string[]; } export interface FormattedAddress { /** One line address representation. */ formatted?: string; /** Address components (optional). */ address?: Address; } /** Physical address */ export interface Address extends AddressStreetOneOf { /** Street name and number. */ streetAddress?: StreetAddress; /** Main address line, usually street and number as free text. */ addressLine1?: string | null; /** Country code. */ country?: string | null; /** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */ subdivision?: string | null; /** City name. */ city?: string | null; /** Zip/postal code. */ postalCode?: string | null; /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */ addressLine2?: string | null; } /** @oneof */ export interface AddressStreetOneOf { /** Street name and number. */ streetAddress?: StreetAddress; /** Main address line, usually street and number as free text. */ addressLine?: string | null; } export interface StreetAddress { /** Street number. */ number?: string; /** Street name. */ name?: string; } export interface AddressLocation { /** Address latitude. */ latitude?: number | null; /** Address longitude. */ longitude?: number | null; } export interface Subdivision { /** Short subdivision code. */ code?: string; /** Subdivision full name. */ name?: string; } export declare enum SubdivisionType { UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE", /** State */ ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1", /** County */ ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2", /** City/town */ ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3", /** Neighborhood/quarter */ ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4", /** Street/block */ ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5", /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */ COUNTRY = "COUNTRY" } /** Subdivision Concordance values */ export interface StandardDetails { /** subdivision iso-3166-2 code according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). e.g. US-NY, GB-SCT, NO-30 */ iso31662?: string | null; } export declare enum OrderStatus { /** Order status not available for this request fieldset. */ NA_ORDER_STATUS = "NA_ORDER_STATUS", /** Order is confirmed and payment isn't required. */ FREE = "FREE", /** Order is paid for but the payment gateway has suspended the payment. */ PENDING = "PENDING", /** Order is paid via a payment gateway. */ PAID = "PAID", /** Order is confirmed but must be paid via offline payment. Status needs to be manually updated to `PAID`. */ OFFLINE_PENDING = "OFFLINE_PENDING", /** Order is awaiting payment at the cashier. */ INITIATED = "INITIATED", /** Order is canceled. */ CANCELED = "CANCELED", /** Order payment is declined. */ DECLINED = "DECLINED", /** Order payment is authorized. */ AUTHORIZED = "AUTHORIZED", /** Order payment is voided. */ VOIDED = "VOIDED", /** Order is partially paid with less than the total amount. */ PARTIALLY_PAID = "PARTIALLY_PAID" } export interface Money { /** * *Deprecated:** Use `value` instead. * @deprecated */ amount?: string; /** Currency code. Must be a valid [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code (e.g., USD). */ currency?: string; /** Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, starts with a single (-), to indicate that the amount is negative. */ value?: string | null; } export interface TicketingTicket { /** Unique ticket number (issued automatically). */ ticketNumber?: string; /** Associated order number. */ orderNumber?: string; /** Ticket definition ID. */ ticketDefinitionId?: string; /** Ticket name. */ name?: string; /** Ticket price. */ price?: Money; /** * Whether the ticket requires payment. * @readonly */ free?: boolean; /** Event and ticket policies. */ policy?: string; /** * Deprecated, use `check_in_url`. * @deprecated */ qrCode?: string; /** Ticket check-in. */ checkIn?: CheckIn; /** Associated order status. */ orderStatus?: OrderStatus; /** Whether order and ticket are visible in order list. */ orderArchived?: boolean; /** Buyer full name. */ orderFullName?: string; /** Guest full name. */ guestFullName?: string | null; /** Guest personal details. */ guestDetails?: GuestDetails; /** Whether ticket is visible in guest list. */ archived?: boolean; /** * Deprecated, use `ticket_pdf_url`. * @deprecated */ ticketPdf?: string; /** Ticket owner member ID. */ memberId?: string | null; /** * Whether ticket was anonymized by GDPR delete. * Anonymized tickets no longer contain personally identifiable information (PII). */ anonymized?: boolean; /** * Ticket check-in URL. * Shown as a QR code image in PDF. * Format: `https://www.wixevents.com/check-in/{ticket number},{event id}`. * Example: `https://www.wixevents.com/check-in/AAAA-AAAA-BB021,00000000-0000-0000-0000-000000000000` */ checkInUrl?: string; /** URL for ticket PDF download. */ ticketPdfUrl?: string; /** Associated order checkout channel type */ channel?: ChannelType; /** * URL to download ticket in the `.pkpass` format for Apple Wallet * @readonly */ walletPassUrl?: string; /** * Whether ticket is canceled. * @readonly */ canceled?: boolean | null; } export interface CheckIn { /** Time of check-in */ created?: Date | null; } export interface GuestDetails { /** Whether ticket belongs to assigned guest. */ guestAssigned?: boolean; /** Guest first name. */ firstName?: string | null; /** Guest last name. */ lastName?: string | null; /** Guest email. */ email?: string | null; /** Full form response. */ form?: FormResponse; /** Contact ID associated with this guest. */ contactId?: string | null; /** Guest phone number. */ phone?: string | null; } export declare enum ChannelType { /** Buyer created the order via an online channel such as a website or mobile app. */ ONLINE = "ONLINE", /** Sales person created the order and collected the money. */ OFFLINE_POS = "OFFLINE_POS" } export interface TicketDetails { /** Unique seat id in the event venue. */ seatId?: string | null; /** * Optional sector label. * @readonly */ sectionLabel?: string | null; /** * Area label. * @readonly */ areaLabel?: string | null; /** * Table label. * @readonly */ tableLabel?: string | null; /** * Row label. * @readonly */ rowLabel?: string | null; /** * Seat label in a row or table. * @readonly */ seatLabel?: string | null; /** Number of places in the spot. If not provided - defaults to 1. */ capacity?: number | null; /** Custom pricing of ticket. */ priceOverride?: string | null; /** Pricing option id. */ pricingOptionId?: string | null; /** * Pricing option name. * @readonly */ pricingOptionName?: string | null; } export interface Invoice { /** Items listed in the invoice. */ items?: Item[]; /** * Total cart amount. * @deprecated */ total?: Money; /** Discount applied to a cart. */ discount?: Discount; /** Tax applied to cart. */ tax?: Tax; /** Total cart amount before discount, tax, and fees. */ subTotal?: Money; /** * Total amount of cart after discount, tax, and fees. * Grand total is calculated in the following order: * 1. Total prices of all items in the cart are calculated. * 2. Discount is subtracted from the cart (if applicable). * 3. Tax is added (if applicable). * 4. Wix ticket service fee is added. */ grandTotal?: Money; /** * Fees applied to the cart. * @readonly */ fees?: Fee[]; /** Total revenue, excluding fees. (Taxes and payment provider fees are not deducted). */ revenue?: Money; /** Invoice preview URL. This value is only returned when the order is paid. */ previewUrl?: string | null; } export interface Item { /** Unique line item ID. */ _id?: string; /** Line item quantity. */ quantity?: number; /** Line item name. */ name?: string; /** Line item price. */ price?: Money; /** Total price for line items. It's calculated by multiplying price and item quantity. */ total?: Money; /** Discount applied to the line item. */ discount?: Discount; /** Tax applied to the item. */ tax?: Tax; /** * Fees applied to the item. * @readonly */ fees?: Fee[]; } export interface Discount { /** Total discount amount. */ amount?: Money; /** Total sum after the discount. */ afterDiscount?: Money; /** * Discount coupon code. * @deprecated */ code?: string; /** * Discount coupon name. * @deprecated */ name?: string; /** * Discount coupon ID. * @deprecated */ couponId?: string; /** Discount items. */ discounts?: DiscountItem[]; } export interface DiscountItem extends DiscountItemDiscountOneOf { /** Coupon discount. */ coupon?: CouponDiscount; /** Pricing plan discount. */ paidPlan?: PaidPlanDiscount; /** Total discount amount. */ amount?: Money; } /** @oneof */ export interface DiscountItemDiscountOneOf { /** Coupon discount. */ coupon?: CouponDiscount; /** Pricing plan discount. */ paidPlan?: PaidPlanDiscount; } export interface CouponDiscount { /** Discount coupon name. */ name?: string; /** Discount coupon code. */ code?: string; /** Discount coupon ID. */ couponId?: string; } export interface PaidPlanDiscount extends PaidPlanDiscountDiscountOneOf { /** Discount by percentage applied to tickets. */ percentDiscount?: PercentDiscount; /** Name of pricing plan. */ name?: string; } /** @oneof */ export interface PaidPlanDiscountDiscountOneOf { /** Discount by percentage applied to tickets. */ percentDiscount?: PercentDiscount; } export interface PercentDiscount { /** Percent rate. */ rate?: string; /** Number of discounted tickets. */ quantityDiscounted?: number; } export interface Tax { /** Tax type. */ type?: TaxType; /** * Tax name. * @readonly */ name?: string; /** Tax rate. */ rate?: string; /** Taxable amount. */ taxable?: Money; /** Total tax amount. */ amount?: Money; } export declare enum TaxType { /** Tax is included in the ticket price. */ INCLUDED = "INCLUDED", /** Tax is added to the order at the checkout. */ ADDED = "ADDED", /** Tax is added to the final total at the checkout. */ ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT" } export interface Fee { /** Fee identifier. */ name?: FeeName; /** How fee is calculated. */ type?: FeeType; /** * Fee rate. * @readonly */ rate?: string; /** Total amount of fee charges. */ amount?: Money; } export declare enum FeeName { /** Wix ticket service fee charges applied to the line item. */ WIX_FEE = "WIX_FEE" } export declare enum FeeType { /** Fee is added to the ticket price at checkout. */ FEE_ADDED = "FEE_ADDED", /** Seller absorbs the fee. It is deducted from the ticket price. */ FEE_INCLUDED = "FEE_INCLUDED", /** Fee is added to the ticket price at checkout. */ FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT" } export interface PaymentDetails { /** Wix Payments transaction */ transaction?: PaymentTransaction; } export interface PaymentTransaction { /** * Wix Payments transaction id * @readonly */ transactionId?: string; /** * Transaction Payment method e.g., "payPal", "creditCard", etc. * @readonly */ method?: string; } export declare enum ScheduledActionEnumAction { /** Action not scheduled. */ UNKNOWN_ACTION = "UNKNOWN_ACTION", /** Captured after the delay. */ CAPTURE = "CAPTURE", /** Void after the delay. */ VOID = "VOID" } export declare enum Action { /** Order can be archived. */ ARCHIVE = "ARCHIVE", /** Order can be unarchived. */ UNARCHIVE = "UNARCHIVE", /** Order can be confirmed. */ CONFIRM = "CONFIRM", /** Order can be captured. */ CAPTURE = "CAPTURE", /** Order can be voided. */ VOID = "VOID" } export interface GiftCardPaymentDetails { /** Gift card payment id. */ giftCardPaymentId?: string | null; /** ID of the app that created the gift card. */ appId?: string | null; /** Whether the gift card payment is voided. */ voided?: boolean | null; /** Amount */ amount?: Money; /** Obfuscated gift card code. */ obfuscatedCode?: string | null; } export interface BalanceSummary { /** Amount left to pay. */ balance?: Money; } export interface OrderDeleted { /** Order deleted timestamp in ISO UTC format. */ timestamp?: Date | null; /** Event ID to which the order belongs. */ eventId?: string; /** Unique order number. */ orderNumber?: string; /** Contact ID associated with this order */ contactId?: string; /** Member ID associated with this order. */ memberId?: string | null; /** * Order created timestamp. * @readonly */ created?: Date | null; /** * Order updated timestamp. * @readonly */ updated?: Date | null; /** Whether order was anonymized by GDPR delete. */ anonymized?: boolean; /** Order type. */ orderType?: OrderType; /** Whether event was triggered by GDPR delete request. */ triggeredByAnonymizeRequest?: boolean; /** Tickets generated after payment. */ tickets?: Ticket[]; } export declare enum OrderType { /** Buyer form is used for all tickets. */ UNASSIGNED_TICKETS = "UNASSIGNED_TICKETS", /** Each order ticket has its own form. */ ASSIGNED_TICKETS = "ASSIGNED_TICKETS" } export interface Ticket { /** Unique issued ticket number. */ ticketNumber?: string; /** Ticket definition ID. */ ticketDefinitionId?: string; /** Ticket check-in. */ checkIn?: CheckIn; /** Ticket price. */ price?: Money; /** Whether ticket is archived. */ archived?: boolean; /** Guest first name. */ firstName?: string | null; /** Guest last name. */ lastName?: string | null; /** Guest email. */ email?: string | null; /** Contact ID associated with this ticket. */ contactId?: string | null; /** Whether ticket is confirmed */ confirmed?: boolean; /** Member ID associated with this ticket. */ memberId?: string | null; /** Ticket form response (only assigned tickets contain separate forms). */ form?: FormResponse; /** Ticket name. */ ticketName?: string; /** Anonymized tickets no longer contain personally identifiable information (PII). */ anonymized?: boolean; /** URL and password to online conference */ onlineConferencingLogin?: OnlineConferencingLogin; /** Seat ID associated with this ticket. */ seatId?: string | null; /** Whether ticket is canceled. */ canceled?: boolean | null; } export interface OnlineConferencingLogin { /** * Link URL to the online conference. * @readonly */ link?: string; /** * Password for the online conference. * @readonly */ password?: string | null; } export interface ListOrdersRequest { /** Offset. */ offset?: number; /** Limit. */ limit?: number; /** * Predefined sets of fields to return. * - `TICKETS`: Returns `tickets`. * - `DETAILS`: Returns `reservationId`, `snapshotId`, `created`, `firstName`, `lastName`, `confirmed`, `status`, `method`, `ticketsQuantity`, `totalPrice`, `ticketsPdf`, `archived`, `fullName`. * - `FORM` : Returns `checkoutForm`. * - `INVOICE`: Returns `invoice`. * * Default: If `fieldset` is not included in the request, `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn` are returned. * */ fieldset?: OrderFieldset[]; /** * Order status. Possible values: * - `FREE`: The order is confirmed, no payment is required. * - `PENDING`: The order was paid, but the payment gateway suspended the payment. * - `PAID`: The order is paid. * - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`. * - `INITIATED`: The order is awaiting for payment. * - `CANCELED`: The order is canceled. * - `DECLINED`: The order is payment is declined. */ status?: OrderStatus[]; /** Event ID to which the order belongs. */ eventId?: string[]; /** Order number. */ orderNumber?: string[]; /** Site member ID. */ memberId?: string[]; /** Field facets, */ facet?: string[]; /** Search filter. You can search `fullName`, `email` and `orderNumber`. */ searchPhrase?: string; /** Event creator ID. */ eventCreatorId?: string[]; /** * Sort order. * Default: `created:asc`. */ sort?: string; /** Order tag. */ tag?: OrderTag[]; /** Guest contact IDs. */ contactId?: string[]; } export declare enum OrderFieldset { /** Include tickets in response. */ TICKETS = "TICKETS", /** Include order details in the response: `status`, `firstName`, `lastName`, `email`, `created`, etc. */ DETAILS = "DETAILS", /** Include `checkoutForm` in the response. */ FORM = "FORM", /** Include `invoice` in the response. */ INVOICE = "INVOICE" } export declare enum OrderTag { /** Return only confirmed orders. */ CONFIRMED = "CONFIRMED", /** Return only unconfirmed orders. */ UNCONFIRMED = "UNCONFIRMED", /** Return only member orders. */ MEMBER = "MEMBER", /** Return only archived orders. */ ARCHIVED = "ARCHIVED", /** Return only non archived orders. */ NON_ARCHIVED = "NON_ARCHIVED", /** Return only orders with all guests checked-in. */ FULLY_CHECKED_IN = "FULLY_CHECKED_IN", /** Return only orders with no guests checked-in. */ NOT_FULLY_CHECKED_IN = "NOT_FULLY_CHECKED_IN" } export interface ListOrdersResponse { /** Total orders matching the given filters. */ total?: number; /** Offset. */ offset?: number; /** Limit. */ limit?: number; /** Orders. */ orders?: Order[]; /** Filter facets. */ facets?: Record; /** Order data enriched facets. */ orderFacets?: OrderFacets; } export interface FacetCounts { /** Facet counts aggregated per value. */ counts?: Record; } export interface OrderFacets { /** Filter facets. */ facets?: Record; } export interface OrderFacetCounts { /** Facet counts aggregated per value */ counts?: Record; } export interface Counts { /** Number or orders */ count?: number; /** Number of tickets within orders */ tickets?: number; /** Number of tickets with check-in */ ticketsCheckIn?: number; } export interface GetOrderRequest { /** Event ID to which the order belongs. */ eventId: string; /** Unique order number. */ orderNumber: string; /** * Predefined sets of fields to return. * - `TICKETS`: Returns `tickets`. * - `DETAILS`: Returns `reservationId`, `snapshotId`, `created`, `firstName`, `lastName`, `confirmed`, `status`, `method`, `ticketsQuantity`, `totalPrice`, `ticketsPdf`, `archived`, `fullName`. * - `FORM` : Returns `checkoutForm`. * - `INVOICE`: Returns `invoice`. * * Default: If `fieldset` is not included in the request, `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn` are returned. * */ fieldset?: OrderFieldset[]; } export interface GetOrderResponse { /** Requested order. */ order?: Order; /** "Add to calendar" links. */ calendarLinks?: CalendarLinks; } export interface CalendarLinks { /** "Add to Google calendar" URL. */ google?: string; /** "Download ICS calendar file" URL. */ ics?: string; } export interface UpdateOrderRequest { /** Event ID to which the order belongs. */ eventId: string; /** Unique order number. */ orderNumber: string; /** Set of field paths to update. */ fields?: string[]; /** Checkout form. */ checkoutForm?: FormResponse; /** Whether order is archived. */ archived?: boolean; } export interface UpdateOrderResponse { /** Updated order. */ order?: Order; } export interface OrderUpdated { /** Order updated timestamp in ISO UTC format. */ timestamp?: Date | null; /** Site language when Order initiated */ language?: string | null; /** Locale in which Order was created. */ locale?: string | null; /** Event ID to which the order belongs. */ eventId?: string; /** Unique order number. */ orderNumber?: string; /** Contact ID associated with this order. */ contactId?: string; /** Member ID associated with this order. */ memberId?: string | null; /** * Order created timestamp. * @readonly */ created?: Date | null; /** * Order updated timestamp. * @readonly */ updated?: Date | null; /** Buyer first name. */ firstName?: string; /** Buyer last name. */ lastName?: string; /** Buyer email. */ email?: string; /** Checkout form response. */ checkoutForm?: FormResponse; /** Whether order is confirmed - occurs once payment gateway processes the payment and funds reach merchant's account. */ confirmed?: boolean; /** * Order status. Possible values: * - `FREE`: The order is confirmed, no payment is required. * - `PENDING`: The order was paid, but the payment gateway suspended the payment. * - `PAID`: The order is paid. * - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`. * - `INITIATED`: The order is awaiting for payment. * - `CANCELED`: The order is canceled. * - `DECLINED`: The order is payment is declined. */ status?: OrderStatus; /** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */ method?: string | null; /** Tickets generated after payment. */ tickets?: Ticket[]; /** Whether order was archived and excluded from results. */ archived?: boolean; /** Whether event was triggered by GDPR delete request. */ triggeredByAnonymizeRequest?: boolean; } export interface BulkUpdateOrdersRequest { /** Event ID to which the order belongs. */ eventId: string; orderNumber?: string[]; /** Set of fields to update. */ fields?: string[]; /** Whether to archive the order. */ archived?: boolean; } export interface BulkUpdateOrdersResponse { /** Updated orders. */ orders?: Order[]; } export interface ConfirmOrderRequest { /** Event ID to which the order belongs. */ eventId: string; /** Order numbers. */ orderNumber?: string[]; } export interface ConfirmOrderResponse { /** Confirmed orders. */ orders?: Order[]; } export interface GetSummaryRequest { /** Event ID. */ eventId?: string | null; } export interface GetSummaryResponse { /** Ticket sales grouped by currency. */ sales?: TicketSales[]; } export interface TicketSales { /** Total balance of confirmed transactions. */ total?: Money; /** Total number of confirmed orders. */ totalOrders?: number; /** Total number of tickets purchased. */ totalTickets?: number; /** Total revenue, excluding fees (taxes and payment provider fees are not deducted). */ revenue?: Money; } export interface GetInvoicePreviewRequest { /** Event ID to which the invoice belongs. */ eventId?: string; /** Order number. */ orderNumber?: string; } export interface RawHttpResponse { body?: Uint8Array; statusCode?: number | null; headers?: HeadersEntry[]; } export interface HeadersEntry { key?: string; value?: string; } export interface GetPaymentInfoRequest { /** Event ID. */ eventId?: string; /** Order number. */ orderNumber?: string; } export interface GetPaymentInfoResponse { transactions?: PaymentTransactionSummary[]; status?: string | null; /** @readonly */ transactionId?: string | null; } export interface PaymentTransactionSummary { /** * Wix Payments transaction id * @readonly */ transactionId?: string; /** * Final transaction status * @readonly */ finalTransactionStatus?: string; /** Transaction events */ events?: PaymentTransactionEvent[]; } export interface PaymentTransactionEvent { /** * Order snapshot id * @readonly */ snapshotId?: string; /** * Transaction status * @readonly */ transactionStatus?: string; /** * Transaction Payment method e.g., "payPal", "creditCard", etc. * @readonly */ paymentMethod?: string; /** * Transaction payment amount * @readonly */ paymentAmount?: Money; /** * Crated date * @readonly */ _createdDate?: Date | null; /** * Reason code * @readonly */ reasonCode?: string | null; /** * Refunded amount * @readonly */ refundedAmount?: Money; } export interface CaptureAuthorizedPaymentRequest { /** Event ID. */ eventId?: string; /** Order number. */ orderNumber: string; } export interface CaptureAuthorizedPaymentResponse { } export interface VoidAuthorizedPaymentRequest { /** Event ID. */ eventId?: string; /** Order number. */ orderNumber: string; } export interface VoidAuthorizedPaymentResponse { } export interface MessageEnvelope { /** App instance ID. */ instanceId?: string | null; /** Event type. */ eventType?: string; /** The identification type and identity data. */ identity?: IdentificationData; /** Stringify payload. */ data?: string; } export interface IdentificationData extends IdentificationDataIdOneOf { /** ID of a site visitor that has not logged in to the site. */ anonymousVisitorId?: string; /** ID of a site visitor that has logged in to the site. */ memberId?: string; /** ID of a Wix user (site owner, contributor, etc.). */ wixUserId?: string; /** ID of an app. */ appId?: string; /** @readonly */ identityType?: WebhookIdentityType; } /** @oneof */ export interface IdentificationDataIdOneOf { /** ID of a site visitor that has not logged in to the site. */ anonymousVisitorId?: string; /** ID of a site visitor that has logged in to the site. */ memberId?: string; /** ID of a Wix user (site owner, contributor, etc.). */ wixUserId?: string; /** ID of an app. */ appId?: string; } export declare enum WebhookIdentityType { UNKNOWN = "UNKNOWN", ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR", MEMBER = "MEMBER", WIX_USER = "WIX_USER", APP = "APP" } export interface OrderConfirmed { /** Order confirmation timestamp in ISO UTC. */ timestamp?: Date | null; /** Site language when Order initiated */ language?: string | null; /** Notifications silenced for this domain event. */ silent?: boolean | null; /** Locale in which Order was created. */ locale?: string | null; /** Event ID to which the order belongs. */ eventId?: string; /** Unique order number. */ orderNumber?: string; /** Contact ID associated with this order. */ contactId?: string; /** Member ID associated with this order. */ memberId?: string | null; /** * Order created timestamp * @readonly */ created?: Date | null; /** Buyer first name. */ firstName?: string; /** Buyer last name. */ lastName?: string; /** Buyer email address. */ email?: string; /** Checkout form response. */ checkoutForm?: FormResponse; /** * Order status. Possible values: * - `FREE`: The order is confirmed, no payment is required. * - `PENDING`: The order was paid, but the payment gateway suspended the payment. * - `PAID`: The order is paid. * - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`. * - `INITIATED`: The order is awaiting for payment. * - `CANCELED`: The order is canceled. * - `DECLINED`: The order is payment is declined. */ status?: OrderStatus; /** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */ method?: string | null; /** Tickets (generated after payment). */ tickets?: Ticket[]; /** Invoice. */ invoice?: Invoice; /** Reservation ID associated with this order. */ reservationId?: string; } export interface OrderPaid { /** Order paid timestamp in ISO UTC. */ timestamp?: Date | null; /** Site language when Order initiated */ language?: string | null; /** Notifications silenced for this domain event. */ silent?: boolean | null; /** Locale in which Order was created. */ locale?: string | null; /** Event ID to which the order belongs. */ eventId?: string; /** Unique order number. */ orderNumber?: string; /** Reservation ID associated with this order. */ reservationId?: string; /** Contact ID associated with this order. */ contactId?: string; /** Member ID associated with this order. */ memberId?: string | null; /** * Order created timestamp * @readonly */ created?: Date | null; /** Buyer first name. */ firstName?: string; /** Buyer last name. */ lastName?: string; /** Buyer email address. */ email?: string; /** Checkout form response. */ checkoutForm?: FormResponse; /** Order status. */ status?: OrderStatus; /** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */ method?: string | null; /** Tickets (generated after payment). */ tickets?: Ticket[]; /** Invoice. */ invoice?: Invoice; } export interface ReservationCreated { /** Reservation created timestamp in ISO UTC format. */ timestamp?: Date | null; /** Event ID to which the reservation belongs. */ eventId?: string; /** * Reservation ID. * Can be used to retrieve a reservation invoice. */ reservationId?: string; /** Reservation expiration timestamp. */ expires?: Date | null; /** Reservation status. */ status?: ReservationStatus; /** Reservation ticket quantities. */ quantities?: TicketQuantity[]; /** Reservation update timestamp. */ _updatedDate?: Date | null; /** Reservation counts. */ counts?: ReservationCount[]; } export declare enum ReservationStatus { /** The Reservation is pending confirmation and will expire after the expiration due time. */ RESERVATION_PENDING = "RESERVATION_PENDING", /** The reservation is confirmed and will not expire. */ RESERVATION_CONFIRMED = "RESERVATION_CONFIRMED", /** The reservation is canceled because of non payment. */ RESERVATION_CANCELED = "RESERVATION_CANCELED", /** The reservation is canceled manually by the buyer. */ RESERVATION_CANCELED_MANUALLY = "RESERVATION_CANCELED_MANUALLY", /** The reservation is expired. */ RESERVATION_EXPIRED = "RESERVATION_EXPIRED" } export interface TicketQuantity { /** Ticket definition ID. */ ticketDefinitionId?: string | null; /** Quantity. */ quantity?: number | null; /** Quantity update timestamp. */ _updatedDate?: Date | null; } export interface ReservationCount { /** Reservation Count snapshot timestamp. */ timestamp?: Date | null; /** Ticket Definition ID. */ ticketDefinitionId?: string; /** Confirmed reservation count. */ confirmedCount?: number; /** Pending reservation count. */ pendingCount?: number; /** True if paid ticket reservation exist. */ paidExists?: boolean; } export interface ReservationUpdated { /** Reservation updated timestamp. */ timestamp?: Date | null; /** Event ID to which the reservation belongs. */ eventId?: string; /** * Reservation ID. * Can be used to retrieve a reservation invoice. */ reservationId?: string; /** Reservation status. */ status?: ReservationStatus; /** Reservation expiration timestamp. */ expires?: Date | null; /** Reservation ticket quantities. */ quantities?: TicketQuantity[]; /** Reservation update timestamp. */ _updatedDate?: Date | null; /** Reservation counts. */ counts?: ReservationCount[]; } export interface GetCheckoutOptionsRequest { } export interface GetCheckoutOptionsResponse { /** Whether any payment method is configured and available for payment. */ paymentMethodConfigured?: boolean; /** Whether coupons are accepted at checkout. */ acceptCoupons?: boolean; /** Whether premium services are enabled. Enabled for free if site does not sell any paid tickets. Selling tickets for a fee requires a premium feature "events_sell_tickets". */ premiumServices?: boolean; /** Whether there are any paid tickets available for sale. */ paidTickets?: boolean; /** Whether gift cards are accepted at checkout. */ acceptGiftCards?: boolean; } export interface ListAvailableTicketsRequest { /** Event ID. If not provided, available tickets for all events in the site will be returned. */ eventId?: string; /** Offset. */ offset?: number; /** Limit. */ limit?: number; /** * Sort order. * Default: `created:asc`. */ sort?: string; state?: State[]; } export declare enum State { INCLUDE_HIDDEN_NOT_ON_SALE = "INCLUDE_HIDDEN_NOT_ON_SALE" } export interface ListAvailableTicketsResponse { /** Ticket definitions meta data. */ metaData?: ResponseMetaData; /** Ticket definitions. */ definitions?: TicketDefinition[]; } export interface ResponseMetaData { /** Number of items in the response. */ count?: number; /** Offset of items. */ offset?: number; /** Total number of matching items. */ total?: number; } export interface TicketDefinition { /** Ticket definition ID. */ _id?: string; /** Ticket price. */ price?: Money; /** Whether the ticket is free (read only). */ free?: boolean; /** Ticket name. */ name?: string; /** Ticket description. */ description?: string; /** Limit of tickets that can be purchased per checkout. If tickets are unlimited in the definition, the limit per checkout is 20 tickets. */ limitPerCheckout?: number; /** Custom sort index. */ orderIndex?: number; /** Event and ticket policies. */ policy?: string; /** Sensitive dashboard data. */ dashboard?: Dashboard; /** Event ID associated with the ticket. */ eventId?: string; /** * Configuration of the fixed-rate Wix service fee that is applied at checkout to each ticket sold. * @readonly */ wixFeeConfig?: WixFeeConfig; /** Ticket sale period. */ salePeriod?: TicketSalePeriod; /** * Ticket sale status. * @readonly */ saleStatus?: TicketSaleStatus; /** Ticket state. */ state?: State[]; /** Ticket pricing. */ pricing?: TicketPricing; } export interface Dashboard { /** Whether ticket is hidden and cannot be sold. */ hidden?: boolean; /** * Number of tickets sold and reserved. * @deprecated */ sold?: number; /** Whether the ticket has limited quantity. */ limited?: boolean; /** Ticket limit. `NULL` if the tickets are unlimited. */ quantity?: number | null; /** Number of unsold tickets. `NULL` if the tickets are unlimited. */ unsold?: number | null; /** Number of tickets sold. */ ticketsSold?: number; /** Number of tickets reserved. */ ticketsReserved?: number; } export interface WixFeeConfig { /** Fee calculation method. */ type?: FeeType; } export interface TicketSalePeriod { /** Ticket sale start timestamp. */ startDate?: Date | null; /** Ticket sale end timestamp. */ endDate?: Date | null; /** Whether to hide this ticket if it's not on sale */ hideNotOnSale?: boolean; } export declare enum TicketSaleStatus { /** Ticket sale is scheduled to start. */ SALE_SCHEDULED = "SALE_SCHEDULED", /** Ticket sale has started. */ SALE_STARTED = "SALE_STARTED", /** Ticket sale has ended. */ SALE_ENDED = "SALE_ENDED" } export interface TicketPricing extends TicketPricingPriceOneOf { /** Ticket price which is read only. */ fixedPrice?: Money; /** Min price per ticket, customizable. */ minPrice?: Money; /** Ticket pricing options. */ pricingOptions?: PricingOptions; /** * Ticket pricing type. * @readonly */ pricingType?: Type; } /** @oneof */ export interface TicketPricingPriceOneOf { /** Ticket price which is read only. */ fixedPrice?: Money; /** Min price per ticket, customizable. */ minPrice?: Money; /** Ticket pricing options. */ pricingOptions?: PricingOptions; } export interface PricingOptions { /** Multiple ticket pricing options. */ options?: PricingOption[]; } export interface PricingOption { /** Ticket pricing option ID. */ _id?: string | null; /** Ticket pricing option name. */ name?: string | null; /** Ticket pricing option price. */ price?: Money; } export declare enum Type { STANDARD = "STANDARD", DONATION = "DONATION" } export interface QueryAvailableTicketsRequest { /** Offset. */ offset?: number; /** Limit. */ limit?: number; /** Ticket definition. */ filter?: Record | null; fieldset?: TicketDefinitionFieldset[]; /** * Sort order. * Default: `created:asc`. */ sort?: string; } export declare enum TicketDefinitionFieldset { /** Include `policy` in the response. */ POLICY = "POLICY", /** Include `dashboard` in the response. */ DASHBOARD = "DASHBOARD" } export interface QueryAvailableTicketsResponse { /** Ticket definitions meta data. */ metaData?: ResponseMetaData; /** Ticket definitions. */ definitions?: TicketDefinition[]; } export interface CreateReservationRequest { /** Event ID to which the reservation belongs. */ eventId: string; /** Tickets to reserve. */ ticketQuantities?: TicketReservationQuantity[]; /** Whether to ignore the available ticket limits upon reservation. */ ignoreLimits?: boolean; /** Whether to allow reservation for hidden tickets. */ allowHiddenTickets?: boolean; } export interface TicketReservationQuantity { /** Ticket definition ID. */ ticketDefinitionId?: string; /** Quantity of tickets to reserve. */ quantity?: number; /** Override the predefined ticket price. */ priceOverride?: string | null; /** Optional ticket details */ ticketDetails?: TicketDetails[]; } export interface CreateReservationResponse { /** Reservation ID. */ _id?: string; /** Reservation expiration timestamp. */ expires?: Date | null; /** Ticket reservations. */ reservations?: TicketReservation[]; /** Reservation invoice. */ invoice?: Invoice; /** Reservation status. */ reservationStatus?: ReservationStatus; } export interface TicketReservation { /** Quantity of reserved tickets. */ quantity?: number; /** An object containing ticket information. */ ticket?: TicketDefinition; /** Optional ticket details. */ ticketDetails?: TicketDetails[]; } export interface CancelReservationRequest { /** Event ID to which the reservation belongs. */ eventId: string; /** Reservation ID. */ _id: string; } export interface CancelReservationResponse { } export interface GetInvoiceRequest { /** Event ID to which the invoice belongs. */ eventId: string; /** Reservation ID. */ reservationId: string; /** Optional discount to be applied on the returned invoice. */ withDiscount?: DiscountRequest; /** Optional benefit granted by the pricing plan to be applied on the returned invoice. */ paidPlanBenefit?: PaidPlanBenefit; } export interface DiscountRequest { /** Discount coupon code. */ couponCode?: string; } export interface PaidPlanBenefit { /** Pricing plan ID. */ planOrderId?: string; /** Pricing plan benefit ID. */ benefitId?: string; } export interface GetInvoiceResponse { /** Invoice with applied discount. */ invoice?: Invoice; /** Discount errors, if relevant. */ discountErrors?: DiscountErrors; /** Reservation expiration time. */ expires?: Date | null; /** * Reservation status. Possible values: * - `RESERVATION_PENDING`: The reservation is pending confirmation. It will expire after a certain amount of time. * - `RESERVATION_CONFIRMED`: The reservation is confirmed and will not expire. * - `RESERVATION_CANCELED`: The reservation is canceled because it's not paid. * - `RESERVATION_CANCELED_MANUALLY`: The reservation is canceled manually by the buyer. * - `RESERVATION_EXPIRED`: The reservation has expired. */ reservationStatus?: ReservationStatus; /** Whether this reservation is already used in checkout. */ reservationOccupied?: boolean; /** Ticket reservations. */ reservations?: TicketReservation[]; } export interface DiscountErrors { /** Object containing error information. */ error?: Error[]; } export interface Error { /** A code identifying the error type. */ code?: string; } export interface GiftCardErrors { /** Error. */ error?: GiftCardErrorsError[]; } export interface GiftCardErrorsError { code?: string; } export interface CheckoutRequest { /** Event ID to which the checkout belongs. */ eventId: string; /** Ticket reservation ID. */ reservationId?: string; /** Member ID (if empty - no site member is associated to this order). */ memberId?: string; /** Discount to apply on the invoice. */ discount?: DiscountRequest; /** Buyer details. */ buyer?: Buyer; /** Guest details. */ guests?: Guest[]; /** Benefit granted by the pricing plan. */ paidPlanBenefit?: PaidPlanBenefit; /** Options controlling the checkout process. */ options?: CheckoutOptions; /** Whether marketing consent was given */ marketingConsent?: boolean | null; } export interface Buyer { /** Buyer first name. */ firstName?: string; /** Buyer last name. */ lastName?: string; /** Buyer email. */ email?: string; } export interface Guest { /** Specific guest info. */ form?: FormResponse; } export interface CheckoutOptions { /** Whether to ignore settings to notify contacts or users. */ silent?: boolean; /** Whether the payment is to be done in person between the buyer and the merchant. When true, the completed order is created with status OFFLINE_PENDING and inPerson payment method. */ payInPerson?: boolean; /** Whether to ignore form validation. */ ignoreFormValidation?: boolean; /** Marks payment as already paid */ markAsPaid?: boolean | null; } export interface CheckoutResponse { /** Created order. */ order?: Order; /** * Order expiration time. * **Note:** Only applicable to orders with the `INITIATED` status. */ expires?: Date | null; /** Ticket reservations. */ reservations?: TicketReservation[]; /** Order page URL. */ orderPageUrl?: string | null; } export interface OrderInitiated { /** Order initiated timestamp in ISO UTC format. */ timestamp?: Date | null; /** Site language when Order initiated */ language?: string | null; /** Locale in which Order was created. */ locale?: string | null; /** Event ID to which the order belongs. */ eventId?: string; /** Unique order number. */ orderNumber?: string; /** Contact ID associated with this order. */ contactId?: string; /** Member ID associated with this order. */ memberId?: string | null; /** * Order created timestamp. * @readonly */ created?: Date | null; /** * Order updated timestamp. * @readonly */ updated?: Date | null; /** Guest first name. */ firstName?: string; /** Guest last name. */ lastName?: string; /** Guest email address. */ email?: string; /** Checkout form response. */ checkoutForm?: FormResponse; /** * Order status. Possible values: * - `FREE`: The order is confirmed, no payment is required. * - `PENDING`: The order was paid, but the payment gateway suspended the payment. * - `PAID`: The order is paid. * - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`. * - `INITIATED`: The order is awaiting for payment. * - `CANCELED`: The order is canceled. * - `DECLINED`: The order is payment is declined. */ status?: OrderStatus; /** Invoice. */ invoice?: Invoice; /** Reservation ID associated with this order. */ reservationId?: string; /** Order was marked as paid. */ markedAsPaid?: boolean | null; } export interface UpdateCheckoutRequest { /** Event ID to which the checkout belongs. */ eventId: string; /** Unique order number. */ orderNumber: string; /** Buyer details. */ buyer?: Buyer; /** Guest details. */ guests?: Guest[]; /** Member ID (if empty - no site member is associated to this order). */ memberId?: string | null; /** Discount to apply on the invoice. */ discount?: DiscountRequest; /** Benefit granted by the pricing plan. */ paidPlanBenefit?: PaidPlanBenefit; } export interface UpdateCheckoutResponse { /** Updated order. */ order?: Order; /** Order page URL. */ orderPageUrl?: string | null; } export interface OrderPageUrls { /** Success order page URL. */ success?: string | null; /** Pending order page URL. */ pending?: string | null; /** Canceled order page URL. */ canceled?: string | null; /** Error order page URL. */ error?: string | null; } export interface PosCheckoutRequest { /** Event ID to which the checkout belongs. */ eventId: string; /** Ticket reservation ID. */ reservationId: string; /** * Payment details ID. * Not required if reservation total is 0. In this case the order will be created with status Free and no payment. */ paymentDetailsId?: string | null; } export interface PosCheckoutResponse { /** Created order. */ order?: Order; /** Time when the order expires, applies to orders with status = INITIATED. */ expires?: Date | null; /** Ticket reservations. */ reservations?: TicketReservation[]; } interface StreetAddressNonNullableFields { number: string; name: string; apt: string; } interface SubdivisionNonNullableFields { name: string; } interface AddressNonNullableFields { streetAddress?: StreetAddressNonNullableFields; subdivisions: SubdivisionNonNullableFields[]; } interface FormattedAddressNonNullableFields { formatted: string; address?: AddressNonNullableFields; } interface InputValueNonNullableFields { inputName: string; value: string; values: string[]; address?: FormattedAddressNonNullableFields; } interface FormResponseNonNullableFields { inputValues: InputValueNonNullableFields[]; } interface MoneyNonNullableFields { amount: string; currency: string; } interface GuestDetailsNonNullableFields { guestAssigned: boolean; form?: FormResponseNonNullableFields; } interface TicketingTicketNonNullableFields { ticketNumber: string; orderNumber: string; ticketDefinitionId: string; name: string; price?: MoneyNonNullableFields; free: boolean; policy: string; qrCode: string; orderStatus: OrderStatus; orderArchived: boolean; orderFullName: string; guestDetails?: GuestDetailsNonNullableFields; archived: boolean; ticketPdf: string; anonymized: boolean; checkInUrl: string; ticketPdfUrl: string; channel: ChannelType; walletPassUrl: string; } interface CouponDiscountNonNullableFields { name: string; code: string; couponId: string; } interface PercentDiscountNonNullableFields { rate: string; quantityDiscounted: number; } interface PaidPlanDiscountNonNullableFields { percentDiscount?: PercentDiscountNonNullableFields; name: string; } interface DiscountItemNonNullableFields { coupon?: CouponDiscountNonNullableFields; paidPlan?: PaidPlanDiscountNonNullableFields; amount?: MoneyNonNullableFields; } interface DiscountNonNullableFields { amount?: MoneyNonNullableFields; afterDiscount?: MoneyNonNullableFields; code: string; name: string; couponId: string; discounts: DiscountItemNonNullableFields[]; } interface TaxNonNullableFields { type: TaxType; name: string; rate: string; taxable?: MoneyNonNullableFields; amount?: MoneyNonNullableFields; } interface FeeNonNullableFields { name: FeeName; type: FeeType; rate: string; amount?: MoneyNonNullableFields; } interface ItemNonNullableFields { _id: string; quantity: number; name: string; price?: MoneyNonNullableFields; total?: MoneyNonNullableFields; discount?: DiscountNonNullableFields; tax?: TaxNonNullableFields; fees: FeeNonNullableFields[]; } interface InvoiceNonNullableFields { items: ItemNonNullableFields[]; total?: MoneyNonNullableFields; discount?: DiscountNonNullableFields; tax?: TaxNonNullableFields; subTotal?: MoneyNonNullableFields; grandTotal?: MoneyNonNullableFields; fees: FeeNonNullableFields[]; revenue?: MoneyNonNullableFields; } interface PaymentTransactionNonNullableFields { transactionId: string; method: string; scheduledAction: ScheduledActionEnumAction; } interface PaymentDetailsNonNullableFields { transaction?: PaymentTransactionNonNullableFields; } interface GiftCardPaymentDetailsNonNullableFields { amount?: MoneyNonNullableFields; } interface BalanceSummaryNonNullableFields { balance?: MoneyNonNullableFields; } export interface OrderNonNullableFields { orderNumber: string; reservationId: string; snapshotId: string; eventId: string; contactId: string; memberId: string; firstName: string; lastName: string; email: string; checkoutForm?: FormResponseNonNullableFields; confirmed: boolean; status: OrderStatus; method: string; ticketsQuantity: number; totalPrice?: MoneyNonNullableFields; ticketsPdf: string; tickets: TicketingTicketNonNullableFields[]; archived: boolean; anonymized: boolean; fullName: string; invoice?: InvoiceNonNullableFields; fullyCheckedIn: boolean; transactionId: string; paymentDetails?: PaymentDetailsNonNullableFields; channel: ChannelType; availableActions: Action[]; giftCardPaymentDetails: GiftCardPaymentDetailsNonNullableFields[]; balanceSummary?: BalanceSummaryNonNullableFields; } export interface ListOrdersResponseNonNullableFields { total: number; offset: number; limit: number; orders: OrderNonNullableFields[]; } interface CalendarLinksNonNullableFields { google: string; ics: string; } export interface GetOrderResponseNonNullableFields { order?: OrderNonNullableFields; calendarLinks?: CalendarLinksNonNullableFields; } export interface UpdateOrderResponseNonNullableFields { order?: OrderNonNullableFields; } export interface BulkUpdateOrdersResponseNonNullableFields { orders: OrderNonNullableFields[]; } export interface ConfirmOrderResponseNonNullableFields { orders: OrderNonNullableFields[]; } interface TicketSalesNonNullableFields { total?: MoneyNonNullableFields; totalOrders: number; totalTickets: number; revenue?: MoneyNonNullableFields; } export interface GetSummaryResponseNonNullableFields { sales: TicketSalesNonNullableFields[]; } export interface GetCheckoutOptionsResponseNonNullableFields { paymentMethodConfigured: boolean; acceptCoupons: boolean; premiumServices: boolean; paidTickets: boolean; acceptGiftCards: boolean; } interface ResponseMetaDataNonNullableFields { count: number; offset: number; total: number; } interface DashboardNonNullableFields { hidden: boolean; sold: number; limited: boolean; ticketsSold: number; ticketsReserved: number; } interface WixFeeConfigNonNullableFields { type: FeeType; } interface TicketSalePeriodNonNullableFields { hideNotOnSale: boolean; } interface PricingOptionNonNullableFields { price?: MoneyNonNullableFields; } interface PricingOptionsNonNullableFields { options: PricingOptionNonNullableFields[]; } interface TicketPricingNonNullableFields { fixedPrice?: MoneyNonNullableFields; minPrice?: MoneyNonNullableFields; pricingOptions?: PricingOptionsNonNullableFields; pricingType: Type; } interface TicketDefinitionNonNullableFields { _id: string; price?: MoneyNonNullableFields; free: boolean; name: string; description: string; limitPerCheckout: number; orderIndex: number; policy: string; dashboard?: DashboardNonNullableFields; eventId: string; wixFeeConfig?: WixFeeConfigNonNullableFields; salePeriod?: TicketSalePeriodNonNullableFields; saleStatus: TicketSaleStatus; state: State[]; pricing?: TicketPricingNonNullableFields; } export interface ListAvailableTicketsResponseNonNullableFields { metaData?: ResponseMetaDataNonNullableFields; definitions: TicketDefinitionNonNullableFields[]; } export interface QueryAvailableTicketsResponseNonNullableFields { metaData?: ResponseMetaDataNonNullableFields; definitions: TicketDefinitionNonNullableFields[]; } interface TicketReservationNonNullableFields { quantity: number; ticket?: TicketDefinitionNonNullableFields; } export interface CreateReservationResponseNonNullableFields { _id: string; reservations: TicketReservationNonNullableFields[]; invoice?: InvoiceNonNullableFields; reservationStatus: ReservationStatus; } interface ErrorNonNullableFields { code: string; } interface DiscountErrorsNonNullableFields { error: ErrorNonNullableFields[]; } interface GiftCardErrorsErrorNonNullableFields { code: string; } interface GiftCardErrorsNonNullableFields { error: GiftCardErrorsErrorNonNullableFields[]; } export interface GetInvoiceResponseNonNullableFields { invoice?: InvoiceNonNullableFields; discountErrors?: DiscountErrorsNonNullableFields; reservationStatus: ReservationStatus; reservationOccupied: boolean; reservations: TicketReservationNonNullableFields[]; giftCardPaymentDetails: GiftCardPaymentDetailsNonNullableFields[]; balanceSummary?: BalanceSummaryNonNullableFields; giftCardErrors?: GiftCardErrorsNonNullableFields; } export interface CheckoutResponseNonNullableFields { order?: OrderNonNullableFields; reservations: TicketReservationNonNullableFields[]; } export interface UpdateCheckoutResponseNonNullableFields { order?: OrderNonNullableFields; } export interface PosCheckoutResponseNonNullableFields { order?: OrderNonNullableFields; reservations: TicketReservationNonNullableFields[]; } export interface BaseEventMetadata { /** App instance ID. */ instanceId?: string | null; /** Event type. */ eventType?: string; /** The identification type and identity data. */ identity?: IdentificationData; } export interface OrderDeletedEnvelope { data: OrderDeleted; metadata: BaseEventMetadata; } /** * This event is triggered when an order is deleted via GDPR request. * @permissionScope Read Events - all read permissions * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS * @permissionScope Manage Events - all permissions * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS * @permissionScope Read Basic Events Order Info * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS * @permissionScope Manage Orders * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS * @permissionId WIX_EVENTS.READ_ORDERS * @webhook * @eventType wix.events.ticketing.events.OrderDeleted */ export declare function onOrderDeleted(handler: (event: OrderDeletedEnvelope) => void | Promise): void; export interface OrderUpdatedEnvelope { data: OrderUpdated; metadata: BaseEventMetadata; } /** @permissionScope Read Events - all read permissions * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS * @permissionScope Manage Events - all permissions * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS * @permissionScope Read Basic Events Order Info * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS * @permissionScope Manage Orders * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS * @permissionId WIX_EVENTS.READ_ORDERS * @webhook * @eventType wix.events.ticketing.events.OrderUpdated */ export declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise): void; export interface OrderConfirmedEnvelope { data: OrderConfirmed; metadata: BaseEventMetadata; } /** @permissionScope Read Events - all read permissions * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS * @permissionScope Manage Events - all permissions * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS * @permissionScope Read Basic Events Order Info * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS * @permissionScope Manage Orders * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS * @permissionId WIX_EVENTS.READ_ORDERS * @webhook * @eventType wix.events.ticketing.events.OrderConfirmed */ export declare function onOrderConfirmed(handler: (event: OrderConfirmedEnvelope) => void | Promise): void; export interface OrderInitiatedEnvelope { data: OrderInitiated; metadata: BaseEventMetadata; } /** @permissionScope Read Events - all read permissions * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS * @permissionScope Manage Events - all permissions * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS * @permissionScope Read Basic Events Order Info * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS * @permissionScope Manage Orders * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS * @permissionId WIX_EVENTS.READ_ORDERS * @webhook * @eventType wix.events.ticketing.events.OrderInitiated */ export declare function onOrderInitiated(handler: (event: OrderInitiatedEnvelope) => void | Promise): void; export interface OrderReservationCreatedEnvelope { data: ReservationCreated; metadata: BaseEventMetadata; } /** @permissionScope Read Events - all read permissions * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS * @permissionScope Manage Events - all permissions * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS * @permissionScope Read Basic Events Order Info * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS * @permissionScope Manage Orders * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS * @permissionId WIX_EVENTS.READ_INVOICE * @webhook * @eventType wix.events.ticketing.events.ReservationCreated */ export declare function onOrderReservationCreated(handler: (event: OrderReservationCreatedEnvelope) => void | Promise): void; export interface OrderReservationUpdatedEnvelope { data: ReservationUpdated; metadata: BaseEventMetadata; } /** @permissionScope Read Events - all read permissions * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS * @permissionScope Manage Events - all permissions * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS * @permissionScope Read Basic Events Order Info * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS * @permissionScope Manage Orders * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS * @permissionId WIX_EVENTS.READ_INVOICE * @webhook * @eventType wix.events.ticketing.events.ReservationUpdated */ export declare function onOrderReservationUpdated(handler: (event: OrderReservationUpdatedEnvelope) => void | Promise): void; /** * Retrieves a list of orders, including ticket data. * @public * @param options - An object representing the available options for retrieving a list of orders. * @permissionId WIX_EVENTS.READ_ORDERS * @permissionScope Read Events - all read permissions * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS * @permissionScope Manage Events - all permissions * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS * @permissionScope Read Basic Events Order Info * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS * @permissionScope Manage Orders * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS * @applicableIdentity APP * @fqn wix.events.ticketing.OrderManagement.ListOrders */ export declare function listOrders(options?: ListOrdersOptions): Promise; export interface ListOrdersOptions { /** Offset. */ offset?: number; /** Limit. */ limit?: number; /** * Predefined sets of fields to return. * - `TICKETS`: Returns `tickets`. * - `DETAILS`: Returns `reservationId`, `snapshotId`, `created`, `firstName`, `lastName`, `confirmed`, `status`, `method`, `ticketsQuantity`, `totalPrice`, `ticketsPdf`, `archived`, `fullName`. * - `FORM` : Returns `checkoutForm`. * - `INVOICE`: Returns `invoice`. * * Default: If `fieldset` is not included in the request, `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn` are returned. */ fieldset?: OrderFieldset[]; /** * Order status. Possible values: * - `FREE`: The order is confirmed, no payment is required. * - `PENDING`: The order was paid, but the payment gateway suspended the payment. * - `PAID`: The order is paid. * - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`. * - `INITIATED`: The order is awaiting for payment. * - `CANCELED`: The order is canceled. * - `DECLINED`: The order is payment is declined. */ status?: OrderStatus[]; /** Event ID to which the order belongs. */ eventId?: string[]; /** Order number. */ orderNumber?: string[]; /** Site member ID. */ memberId?: string[]; /** Field facets. */ facet?: string[]; /** Search filter. You can search `fullName`, `email` and `orderNumber`. */ searchPhrase?: string; /** Event creator ID. */ eventCreatorId?: string[]; /** * Sort order. * Default: `created:asc`. */ sort?: string; /** Order tag. */ tag?: OrderTag[]; /** Guest contact IDs. */ contactId?: string[]; } /** * Retrieves an order, including ticket data. * * @public * @requiredField identifiers * @requiredField identifiers.eventId * @requiredField identifiers.orderNumber * @param options - An object representing the available options for getting an order. * @param identifiers - An object containing identifiers for the order to be retrieved. * @permissionId WIX_EVENTS.READ_ORDERS * @permissionScope Read Events - all read permissions * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS * @permissionScope Manage Events - all permissions * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS * @permissionScope Read Basic Events Order Info * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS * @permissionScope Manage Orders * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS * @applicableIdentity APP * @returns Requested order. * @fqn wix.events.ticketing.OrderManagement.GetOrder */ export declare function getOrder(identifiers: GetOrderIdentifiers, options?: GetOrderOptions): Promise; export interface GetOrderIdentifiers { /** Event ID to which the order belongs. */ eventId: string; /** Unique order number. */ orderNumber: string; } export interface GetOrderOptions { /** * Predefined sets of fields to return. * - `TICKETS`: Returns `tickets`. * - `DETAILS`: Returns `reservationId`, `snapshotId`, `created`, `firstName`, `lastName`, `confirmed`, `status`, `method`, `ticketsQuantity`, `totalPrice`, `ticketsPdf`, `archived`, `fullName`. * - `FORM` : Returns `checkoutForm`. * - `INVOICE`: Returns `invoice`. * * Default: If `fieldset` is not included in the request, `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn` are returned. */ fieldset?: OrderFieldset[]; } /** * Updates an order. * @public * @requiredField identifiers * @requiredField identifiers.eventId * @requiredField identifiers.orderNumber * @param options - An object representing the available options for updating an order. * @param identifiers - An object containing identifiers for the order to be updated. * @permissionId WIX_EVENTS.MANAGE_ORDERS * @permissionScope Manage Events - all permissions * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS * @permissionScope Manage Orders * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS * @applicableIdentity APP * @fqn wix.events.ticketing.OrderManagement.UpdateOrder */ export declare function updateOrder(identifiers: UpdateOrderIdentifiers, options?: UpdateOrderOptions): Promise; export interface UpdateOrderIdentifiers { /** Event ID to which the order belongs. */ eventId: string; /** Unique order number. */ orderNumber: string; } export interface UpdateOrderOptions { /** Set of field paths to update. */ fields?: string[]; /** Checkout form. */ checkoutForm?: FormResponse; /** Whether order is archived. */ archived?: boolean; } /** * Archives multiple orders. * @public * @requiredField eventId * @param options - An object representing the available options for confirming an order. * @param eventId - Event ID to which the order belongs. * @permissionId WIX_EVENTS.MANAGE_ORDERS * @permissionScope Manage Events - all permissions * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS * @permissionScope Manage Orders * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS * @applicableIdentity APP * @fqn wix.events.ticketing.OrderManagement.BulkUpdateOrders */ export declare function bulkUpdateOrders(eventId: string, options?: BulkUpdateOrdersOptions): Promise; export interface BulkUpdateOrdersOptions { /** Unique order number. */ orderNumber?: string[]; /** Set of fields to update. */ fields?: string[]; /** Whether to archive the order. */ archived?: boolean; } /** * Confirms an order. * * * This function changes order status from `INITIATED`, `PENDING`, `OFFLINE_PENDING` to `PAID`. * Confirming orders with `INITIATED` or `PENDING` status triggers an email with the tickets to the buyer (and to additional guests, if provided). * @public * @requiredField eventId * @param options - An object representing the available options for confirming an order. * @param eventId - Event ID to which the order belongs. * @permissionId WIX_EVENTS.MANAGE_ORDERS * @permissionScope Manage Events - all permissions * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS * @permissionScope Manage Orders * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS * @applicableIdentity APP * @fqn wix.events.ticketing.OrderManagement.ConfirmOrder */ export declare function confirmOrder(eventId: string, options?: ConfirmOrderOptions): Promise; export interface ConfirmOrderOptions { /** Order numbers. */ orderNumber?: string[]; } /** * Retrieves a summary of total ticket sales. * * @public * @param options - An object representing the available options for retrieving a summary of total ticket sales. * @permissionId WIX_EVENTS.READ_ORDERS * @permissionScope Read Events - all read permissions * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS * @permissionScope Manage Events - all permissions * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS * @permissionScope Read Basic Events Order Info * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS * @permissionScope Manage Orders * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS * @applicableIdentity APP * @fqn wix.events.ticketing.OrderManagement.GetSummary */ export declare function getSummary(options?: GetSummaryOptions): Promise; export interface GetSummaryOptions { /** Event ID. */ eventId?: string | null; } /** * Captures authorized payment asynchronously. * Eventually order will become paid. * For orders with non-authorized payments request will fail. * @param orderNumber - Order number. * @public * @requiredField orderNumber * @permissionId WIX_EVENTS.MANAGE_ORDERS * @permissionScope Manage Events - all permissions * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS * @permissionScope Manage Orders * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS * @applicableIdentity APP * @fqn wix.events.ticketing.OrderManagement.CaptureAuthorizedPayment */ export declare function captureAuthorizedPayment(orderNumber: string, options?: CaptureAuthorizedPaymentOptions): Promise; export interface CaptureAuthorizedPaymentOptions { /** Event ID. */ eventId?: string; } /** * Voids authorized payment asynchronously. * Eventually order will become voided. * For orders with non-authorized payments request will fail. * @param orderNumber - Order number. * @public * @requiredField orderNumber * @permissionId WIX_EVENTS.MANAGE_ORDERS * @permissionScope Manage Events - all permissions * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS * @permissionScope Manage Orders * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS * @applicableIdentity APP * @fqn wix.events.ticketing.OrderManagement.VoidAuthorizedPayment */ export declare function voidAuthorizedPayment(orderNumber: string, options?: VoidAuthorizedPaymentOptions): Promise; export interface VoidAuthorizedPaymentOptions { /** Event ID. */ eventId?: string; } /** * Retrieves checkout details. * @public * @permissionId WIX_EVENTS.READ_CHECKOUT * @permissionScope Manage Events - all permissions * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS * @permissionScope Manage Orders * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS * @applicableIdentity APP * @applicableIdentity VISITOR * @fqn wix.events.ticketing.CheckoutService.GetCheckoutOptions */ export declare function getCheckoutOptions(): Promise; /** * Returns tickets available to reserve. * * @public * @param options - An object representing the available options for retrieving a list of tickets available for reservation. * @permissionId WIX_EVENTS.READ_CHECKOUT * @permissionScope Manage Events - all permissions * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS * @permissionScope Manage Orders * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS * @applicableIdentity APP * @applicableIdentity VISITOR * @fqn wix.events.ticketing.CheckoutService.ListAvailableTickets */ export declare function listAvailableTickets(options?: ListAvailableTicketsOptions): Promise; export interface ListAvailableTicketsOptions { /** Event ID. If not provided, available tickets for all events in the site will be returned. */ eventId?: string; /** Offset. */ offset?: number; /** Limit. */ limit?: number; /** * Sort order. * Default: `created:asc`. */ sort?: string; state?: State[]; } /** * Returns tickets available to reserve. * * @public * @param options - An object representing the available options for retrieving a list of tickets available for reservation. * @permissionId WIX_EVENTS.READ_CHECKOUT * @permissionScope Manage Events - all permissions * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS * @permissionScope Manage Orders * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS * @applicableIdentity APP * @applicableIdentity VISITOR * @fqn wix.events.ticketing.CheckoutService.QueryAvailableTickets */ export declare function queryAvailableTickets(options?: QueryAvailableTicketsOptions): Promise; export interface QueryAvailableTicketsOptions { /** Offset. */ offset?: number; /** Limit. */ limit?: number; /** Ticket definition. */ filter?: Record | null; fieldset?: TicketDefinitionFieldset[]; /** * Sort order. * Default: `created:asc`. */ sort?: string; } /** * Reserves tickets for 20 minutes. * * * Reserved tickets are deducted from ticket stock and cannot be bought by another site visitor. * When the reservation expires, the tickets are added back to the stock. * @public * @requiredField eventId * @param options - An object representing the available options for creating a reservation. * @param eventId - Event ID to which the reservation belongs. * @permissionId WIX_EVENTS.CHECKOUT * @permissionScope Manage Events - all permissions * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS * @permissionScope Manage Orders * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS * @applicableIdentity APP * @applicableIdentity VISITOR * @fqn wix.events.ticketing.CheckoutService.CreateReservation */ export declare function createReservation(eventId: string, options?: CreateReservationOptions): Promise; export interface CreateReservationOptions { /** Tickets to reserve. */ ticketQuantities?: TicketReservationQuantity[]; /** Whether to ignore the available ticket limits upon reservation. */ ignoreLimits?: boolean; /** Whether to allow reservation for hidden tickets. */ allowHiddenTickets?: boolean; } /** * Cancels ticket reservation and returns tickets to stock. * * @param _id - Reservation ID. * @public * @requiredField _id * @requiredField eventId * @param identifiers - An object containing identifiers for the reservation to be cancelled. * @param eventId - Event ID to which the reservation belongs. * @permissionId WIX_EVENTS.CHECKOUT * @permissionScope Manage Events - all permissions * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS * @permissionScope Manage Orders * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS * @applicableIdentity APP * @applicableIdentity VISITOR * @fqn wix.events.ticketing.CheckoutService.CancelReservation */ export declare function cancelReservation(_id: string, eventId: string): Promise; /** * Generates a preview of an invoice, including the given coupon or pricing plan. * @param reservationId - Reservation ID. * @public * @requiredField eventId * @requiredField reservationId * @param options - An object representing the available options for generating a preview of a reservation invoice. * @param identifiers - An object containing identifiers for the reservation invoice preview to be generated. * @param eventId - Event ID to which the invoice belongs. * @permissionId WIX_EVENTS.READ_INVOICE * @permissionScope Read Events - all read permissions * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS * @permissionScope Manage Events - all permissions * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS * @permissionScope Read Basic Events Order Info * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS * @permissionScope Manage Orders * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS * @applicableIdentity APP * @applicableIdentity VISITOR * @fqn wix.events.ticketing.CheckoutService.GetInvoice */ export declare function getInvoice(reservationId: string, eventId: string, options?: GetInvoiceOptions): Promise; export interface GetInvoiceOptions { /** Optional discount to be applied on the returned invoice. */ withDiscount?: DiscountRequest; /** Optional benefit granted by the pricing plan to be applied on the returned invoice. */ paidPlanBenefit?: PaidPlanBenefit; } /** * Checkouts the reserved tickets. * * * Creates an order and associates it with a site visitor contact. * Guest details are received from the [Registration Form](https://www.wix.com/velo/reference/wix-events-v2/forms/introduction) input fields. * * There is a possibility to use a separate ready-made Wix checkout form where the user will be redirected from your non-Wix site or a custom ticket picker created with Velo. * To build the checkout form path, get your event base URL by using the [`getEvent()`](https://www.wix.com/velo/reference/wix-events-backend/wixevents/getevent) function and add the following path: * `/{{EVENT_PAGE_SLUG}}/{{SLUG}}/ticket-form?reservationId={{YOUR_RESERVATION_ID}}` * * Example: `https://johndoe.wixsite.com/weddings/event-details/doe-wedding/ticket-form?reservationId=2be6d34a-2a1e-459f-897b-b4a66e73f69a` * @public * @requiredField eventId * @requiredField options.guests.form * @param options - An object representing the available options for checking out a reserved ticket. * @param eventId - Event ID to which the checkout belongs. * @permissionId WIX_EVENTS.CHECKOUT * @permissionScope Manage Events - all permissions * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS * @permissionScope Manage Orders * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS * @applicableIdentity APP * @applicableIdentity VISITOR * @fqn wix.events.ticketing.CheckoutService.Checkout */ export declare function checkout(eventId: string, options?: CheckoutOptionsForRequest): Promise; export interface CheckoutOptionsForRequest { /** Ticket reservation ID. */ reservationId?: string; /** Member ID (if empty - no site member is associated to this order). */ memberId?: string; /** Discount to apply on the invoice. */ discount?: DiscountRequest; /** Buyer details. */ buyer?: Buyer; /** Guest details. */ guests?: Guest[]; /** Benefit granted by the pricing plan. */ paidPlanBenefit?: PaidPlanBenefit; /** Options controlling the checkout process. */ options?: CheckoutOptions; /** Whether marketing consent was given */ marketingConsent?: boolean | null; } /** * Updates order and tickets. * * * Only applicable for orders with `INITIATED`, `PENDING`, `OFFLINE_PENDING` statuses. * @param orderNumber - Unique order number. * @public * @requiredField eventId * @requiredField orderNumber * @param options - An object representing the available options for updating an order and tickets. * @param identifiers - An object containing identifiers for the order and tickets to be updated. * @param eventId - Event ID to which the checkout belongs. * @permissionId WIX_EVENTS.CHECKOUT * @permissionScope Manage Events - all permissions * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS * @permissionScope Manage Orders * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS * @applicableIdentity APP * @applicableIdentity VISITOR * @fqn wix.events.ticketing.CheckoutService.UpdateCheckout */ export declare function updateCheckout(orderNumber: string, eventId: string, options?: UpdateCheckoutOptions): Promise; export interface UpdateCheckoutOptions { /** Buyer details. */ buyer?: Buyer; /** Guest details. */ guests?: Guest[]; /** Member ID (if empty - no site member is associated to this order). */ memberId?: string | null; /** Discount to apply on the invoice. */ discount?: DiscountRequest; /** Benefit granted by the pricing plan. */ paidPlanBenefit?: PaidPlanBenefit; } /** * Creates order with payment details already initiated via Cashier Pay API. * @public * @documentationMaturity preview * @requiredField eventId * @requiredField options.reservationId * @param eventId - Event ID to which the checkout belongs. * @permissionId WIX_EVENTS.MANAGE_ORDERS * @permissionScope Manage Events - all permissions * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS * @permissionScope Manage Orders * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS * @applicableIdentity APP * @fqn wix.events.ticketing.CheckoutService.PosCheckout */ export declare function posCheckout(eventId: string, options?: PosCheckoutOptions): Promise; export interface PosCheckoutOptions { /** Ticket reservation ID. */ reservationId: string; /** * Payment details ID. * Not required if reservation total is 0. In this case the order will be created with status Free and no payment. */ paymentDetailsId?: string | null; } export {};