> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # Resource: Orders # Type: Order Object # Link: https://dev.wix.com/docs/api-reference/business-solutions/events/registration/ticketing/orders/order-object.md ## Schema: ```json Type: Order Object | type: Order - name: orderNumber | type: string | description: Unique order number. - name: reservationId | type: string | description: Reservation ID. - name: snapshotId | type: string | description: Payment snapshot ID. Empty if `status` of the order is `"FREE"`. - name: eventId | type: string | description: Event ID to which the order belongs. - name: contactId | type: string | description: Contact ID of buyer, resolved using the email address specified. See the Contacts API for additional information. - name: memberId | type: string | description: Buyer member ID, if applicable. See the Members API for additional information. - name: created | type: string | description: Date and time the order was created. - name: seconds | type: string | description: - name: nanos | type: number | description: - name: firstName | type: string | description: Guest first name. - name: lastName | type: string | description: Guest last name. - name: email | type: string | description: Guest email address. - name: checkoutForm | type: FormResponse | description: Checkout form response. When each purchased ticket is assigned to a guest, guest forms are returned for each ticket, and buyer info is returned. - name: inputValues | type: Array | description: Form field inputs. - name: inputName | type: string | description: Form field input name. - name: value | type: string | description: Form field value. - name: values | type: Array | description: Form field values. - name: confirmed | type: boolean | description: Whether the order is confirmed. Triggered once the payment gateway processes the payment and funds reach the merchant's account. - name: status | type: string | description: Order status. enum: NA_ORDER_STATUS, FREE, PENDING, PAID, OFFLINE_PENDING, INITIATED, CANCELED, DECLINED, AUTHORIZED, VOIDED, PARTIALLY_PAID - name: method | type: string | description: Payment method used for purchase, for example, "payPal", "creditCard", etc. - name: ticketsQuantity | type: number | description: Amount of tickets ordered. - name: totalPrice | type: Money | description: Total order price. - name: amount | type: string | description: *Deprecated:** Use `value` instead. - name: currency | type: string | description: 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. For example, `USD`. - name: value | type: string | description: 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. - name: value | type: string | description: - name: ticketsPdf | type: string | description: Ticket PDF URL. - name: tickets | type: Array | description: Tickets (generated after payment). - name: ticketNumber | type: string | description: Unique ticket number which is assigned automatically when creating a ticket. - name: orderNumber | type: string | description: Associated order number. - name: ticketDefinitionId | type: string | description: Ticket definition ID. See the Ticket Definition API for additional information. - name: name | type: string | description: Ticket type. - name: price | type: Money | description: Ticket price. - name: free | type: boolean | description: Whether the ticket requires payment. - name: policy | type: string | description: Ticket and event policies. - name: checkIn | type: CheckIn | description: Ticket check-in. - name: created | type: string | description: Time of a ticket's check-in. - name: orderStatus | type: string | description: Associated order status. - name: orderArchived | type: boolean | description: Whether the order and ticket are archived. If set to `true`, they aren't visible in the order list. - name: orderFullName | type: string | description: Buyer full name. - name: guestFullName | type: string | description: Guest full name. - name: guestDetails | type: GuestDetails | description: Guest personal details. - name: guestAssigned | type: boolean | description: Whether ticket belongs to assigned guest. - name: firstName | type: string | description: Guest first name. - name: lastName | type: string | description: Guest last name. - name: email | type: string | description: Guest email. - name: form | type: FormResponse | description: Full form response. - name: contactId | type: string | description: Contact ID associated with this guest. - name: phone | type: string | description: Guest phone number. - name: archived | type: boolean | description: Whether the ticket is visible in an order. - name: memberId | type: string | description: Ticket owner member ID. - name: anonymized | type: boolean | description: Whether ticket was anonymized by GDPR delete. Anonymized tickets no longer contain personally identifiable information (PII). - name: checkInUrl | type: string | description: Ticket check-in URL. Shown as 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"` - name: ticketPdfUrl | type: string | description: URL for ticket PDF download. - name: channel | type: string | description: Associated order checkout channel type. enum: ONLINE, OFFLINE_POS - name: walletPassUrl | type: string | description: URL to download a ticket in `.pkpass` format for Apple Wallet. - name: canceled | type: boolean | description: Whether ticket is canceled. - name: value | type: boolean | description: - name: archived | type: boolean | description: Whether the order is archived. - name: anonymized | type: boolean | description: Whether the order is anonymized by GDPR delete. - name: fullName | type: string | description: Guest full name. - name: invoice | type: Invoice | description: Order invoice. - name: items | type: Array | description: - name: id | type: string | description: Unique line item ID. - name: quantity | type: number | description: Line item quantity. - name: name | type: string | description: Line item name. - name: price | type: Money | description: Line item price. - name: total | type: Money | description: Total price for line items. Always equal to price * quantity. - name: discount | type: Discount | description: Discount applied to the line item. - name: tax | type: Tax | description: Tax applied to the item. - name: fees | type: Array | description: Fees applied to the item. - name: total | type: Money | description: Total cart amount. - name: discount | type: Discount | description: Discount applied to a cart. - name: amount | type: Money | description: Total discount amount. - name: afterDiscount | type: Money | description: Total sum after the discount. - name: code | type: string | description: Discount coupon code. - name: name | type: string | description: Discount coupon name. - name: couponId | type: string | description: Discount coupon ID. - name: discounts | type: Array | description: Discount items. - name: tax | type: Tax | description: Tax applied to a cart. - name: type | type: string | description: Tax type. - name: name | type: string | description: Tax name. - name: rate | type: string | description: Tax rate. - name: taxable | type: Money | description: Taxable amount. - name: amount | type: Money | description: Total tax amount. - name: subTotal | type: Money | description: Total cart amount before discount, tax, and fees. - name: grandTotal | type: Money | description: Total amount of a 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. - name: fees | type: Array | description: Fees applied to the cart. - name: name | type: string | description: Fee identifier. - name: type | type: string | description: How fee is calculated. - name: rate | type: string | description: Fee rate. - name: amount | type: Money | description: Total amount of fee charges. - name: revenue | type: Money | description: Total revenue, excluding fees. Taxes and payment provider fees aren't deducted. - name: previewUrl | type: string | description: Invoice preview URL. Only returned if the order is paid. - name: fullyCheckedIn | type: boolean | description: Whether all tickets in an order are checked in. - name: paymentDetails | type: PaymentDetails | description: Internal order payment details. - name: transaction | type: PaymentTransaction | description: Wix Payments transaction. - name: transactionId | type: string | description: Wix Payments transaction ID. - name: method | type: string | description: Transaction payment method, for example, "payPal", "creditCard", etc. - name: channel | type: string | description: Checkout channel type. - name: updated | type: string | description: Date and time the order was last updated. - name: marketingConsent | type: boolean | description: Whether marketing consent was given. ```