Order

{
  "lineItems": [
    {
      object (LineItem)
    }
  ]
}

object (LineItem)

List of order line items. At least 1 lineItem is required and at-most 50 is allowed. All line items must belong to same vertical.

{
  "paymentResult": {
    object (PaymentResult)
  },
  "paymentInfo": {
    object (PaymentInfo)
  }
}

object (PaymentResult)

Payment result that's used by integrator for completing a transaction. This field will be populated by actions on Google if the checkout experience is managed by actions-on-Google.

object (PaymentInfo)

Payment information regarding the order that's useful for user facing interaction.

{

  // Union field result can be only one of the following:
  "googlePaymentData": string,
  "merchantPaymentMethodId": string
  // End of list of possible types for union field result.
}

string

Google provided payment method data. If your payment processor is listed as Google supported payment processor here: https://developers.google.com/pay/api/ Navigate to your payment processor through the link to find out more details. Otherwise, refer to following documentation for payload details. https://developers.google.com/pay/api/payment-data-cryptography

string

Merchant/Action provided payment method chosen by user.

{
  "paymentMethodDisplayInfo": {
    object (PaymentMethodDisplayInfo)
  },
  "paymentMethodProvenance": enum (PaymentMethodProvenance)
}

object (PaymentMethodDisplayInfo)

The display info of the payment method used for the transaction.

enum (PaymentMethodProvenance)

Provenance of the payment method used for the transaction. User may have registered the same payment method with both google and merchant.

{
  "paymentType": enum (PaymentType),
  "paymentMethodDisplayName": string
}

enum (PaymentType)

The type of the payment.

string

User visible name of the payment method. For example, VISA **** 1234 Checking acct **** 5678

{
  "coupon": string
}

string

Required: Coupon code applied to this offer.

{
  "status": enum (PurchaseStatus),
  "userVisibleStatusLabel": string,
  "type": enum (PurchaseType),
  "returnsInfo": {
    object (PurchaseReturnsInfo)
  },
  "fulfillmentInfo": {
    object (PurchaseFulfillmentInfo)
  },
  "extension": {
    "@type": string,
    field1: ...,
    ...
  },
  "purchaseLocationType": enum (PurchaseLocationType),
  "errors": [
    {
      object (PurchaseError)
    }
  ]
}

enum (PurchaseStatus)

Required: Overall Status for the order.

string

User visible label/string for the status. Max allowed length is 50 chars.

enum (PurchaseType)

Required: type of purchase.

object (PurchaseReturnsInfo)

Return info for the order.

object (PurchaseFulfillmentInfo)

Fulfillment info for the order.

object

Any extra fields exchanged between merchant and google.

An object containing fields of an arbitrary type. An additional field "@type" contains a URI identifying the type. Example: { "id": 1234, "@type": "types.example.com/standard/id" }.

enum (PurchaseLocationType)

Location of the purchase (in-store / online)

object (PurchaseError)

Optional: Errors because of which this order was rejected.

{
  "type": enum (ErrorType),
  "description": string,
  "entityId": string,
  "updatedPrice": {
    object (PriceAttribute)
  },
  "availableQuantity": integer
}

enum (ErrorType)

Required: This represents the granular reason why an order gets rejected by the merchant.

string

Additional error description.

string

Entity Id that corresponds to the error. Example this can correspond to LineItemId / ItemOptionId.

object (PriceAttribute)

Relevant in case of PRICE_CHANGED / INCORRECT_PRICE error type.

integer

Available quantity now. Applicable in case of AVAILABILITY_CHANGED.

{
  "ticketEvent": {
    object (TicketEvent)
  }
}

object (TicketEvent)

The event applied to all line item tickets.

{
  "type": enum (Type),
  "name": string,
  "description": string,
  "url": string,
  "location": {
    object (Location)
  },
  "eventCharacters": [
    {
      object (EventCharacter)
    }
  ],
  "startDate": {
    object (Time)
  },
  "endDate": {
    object (Time)
  },
  "doorTime": {
    object (Time)
  }
}

enum (Type)

Required: type of the ticket event, e.g. movie, concert.

string

Required: name of the event. For example, if the event is a movie, this should be the movie name.

string

description of the event.

string

Url to the event info.

object (Location)

The location where the event is happening, or an organization is located.

object (EventCharacter)

The characters related to this event. It can be directors or actors of a movie event, or performers of a concert, etc.

object (Time)

Start time.

object (Time)

End time.

object (Time)

Entry time, which might be different from the event start time. e.g. the event starts at 9am, but entry time is 8:30am.

{
  "type": enum (Type),
  "name": string,
  "image": {
    object (Image)
  }
}

enum (Type)

type of the event character, e.g. actor or director.

string

name of the character.

object (Image)

Character's images.