Request

View normalized Markdown

Requests that are managed in this app

graphql

type Request {
  accessToken: ID!
  billingAddress: Address
  checkoutHold: CheckoutHold!
  checkoutPolicy: OfferableCheckoutPolicy!
  contact: Contact
  customFieldsCompletion(
    requiredByStage: CustomFieldsRequiredByStageEnum = BEFORE_PAYMENT
  ): CustomFieldsCompletionSummary!
  discounts: [RequestDiscount!]
  id: ID!
  invoices: [Invoice!]!
  number: String!
  paymentState: RequestPaymentStateEnum!
  requestItems(discarded: [Boolean!]): [RequestItem!]!
  requiresShipping: Boolean!
  salesTaxPayments: [SalesTaxPayment!]!
  shareablePublicTicketsUrl(
    attendanceId: ID
    format: TicketFormatEnum = PDF
  ): String
  shippingAddress: Address
  state: RequestStateEnum!
  totalDiscount: Money!
  totalGrossValue: Money!
  totalInvoiceableGrossValue: Money!
  totalValue: Money! @deprecated
  totalVouchers: Money!
  vouchers: [RequestVoucher!]!
}

Fields

`Request.accessToken` · `ID!` non-null scalar

Use this token to request a resource without authentication. Token lifetime depends on the resource.

`Request.billingAddress` · `Address` object

`Request.checkoutHold` · `CheckoutHold!` non-null object

Time left before an unpaid cart releases its availability.

`Request.checkoutPolicy` · `OfferableCheckoutPolicy!` non-null object

Which checkout operation completes this cart and whether its items can be checked out together.

`Request.contact` · `Contact` object

`Request.customFieldsCompletion` · `CustomFieldsCompletionSummary!` non-null object

Summary of custom field completion for all request items, their attendances, and the contact in this request.

`Request.customFieldsCompletion.requiredByStage` · `CustomFieldsRequiredByStageEnum` enum

Count fields as required when they must be completed by this stage.

`Request.discounts` · `[RequestDiscount!]` list object

Discounts applied to the cart, including coupons and promotions.

`Request.id` · `ID!` non-null scalar

`Request.invoices` · `[Invoice!]!` non-null object

`Request.number` · `String!` non-null scalar

`Request.paymentState` · `RequestPaymentStateEnum!` non-null enum

`Request.requestItems` · `[RequestItem!]!` non-null object

`Request.requestItems.discarded` · `[Boolean!]` list scalar

`Request.requiresShipping` · `Boolean!` non-null scalar

Whether an active cart item requires a delivery address.

`Request.salesTaxPayments` · `[SalesTaxPayment!]!` non-null object

`Request.shareablePublicTicketsUrl` · `String` scalar

URL for tickets download

`Request.shareablePublicTicketsUrl.attendanceId` · `ID` scalar

Mandatory for the .pkpass format if the request contains more than one printable attendance. Can be omitted for other formats.

`Request.shareablePublicTicketsUrl.format` · `TicketFormatEnum` enum

`Request.shippingAddress` · `Address` object

`Request.state` · `RequestStateEnum!` non-null enum

`Request.totalDiscount` · `Money!` non-null scalar

total value of discounts

`Request.totalGrossValue` · `Money!` non-null scalar

total price value including external taxes, discounts and account transactions

`Request.totalInvoiceableGrossValue` · `Money!` non-null scalar

total value of invoiceable items including external taxes and discounts

`Request.totalValue` · `Money!` deprecated non-null scalar

total price value including discounts and account transactions

`Request.totalVouchers` · `Money!` non-null scalar

total value of vouchers

`Request.vouchers` · `[RequestVoucher!]!` non-null object

Vouchers applied to the cart as payment.

Returned By

request query

Member Of

Invoice object · RequestApplyCodePayload object · RequestApplyVoucherPayload object · RequestCancelExpiredCheckoutHoldPayload object · RequestCancelPayload object · RequestCreatePayload object · RequestFinalizePayload object · RequestItemCreatePayload object · RequestItemUpdatePayload object · RequestPaymentInitiatePayload object · RequestRemoveCodePayload object · RequestUpdatePayload object