Order

{
  "email": string,
  "firstName": string,
  "lastName": string,
  "displayName": string,
  "phoneNumbers": [
    {
      object (PhoneNumber)
    }
  ]
}

string

User email, Eg: janedoe@gmail.com.

string

First name of the user.

string

Last name of the user.

string

Display name of the user, might be different from first or last name.

object (PhoneNumber)

Phone numbers of the user.

{
  "e164PhoneNumber": string,
  "extension": string,
  "preferredDomesticCarrierCode": string
}

string

Phone number in E.164 format, as defined in International Telecommunication Union (ITU) Recommendation E.164. wiki link: https://en.wikipedia.org/wiki/E.164

string

Extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. It is defined as a string here to accommodate for the possible use of a leading zero in the extension (organizations have complete freedom to do so, as there is no standard defined). Other than digits, some other dialling characters such as "," (indicating a wait) may be stored here. For example, in xxx-xxx-xxxx ext. 123, "123" is the extension.

string

The carrier selection code that is preferred when calling this phone number domestically. This also includes codes that need to be dialed in some countries when calling from landlines to mobiles or vice versa. For example, in Columbia, a "3" needs to be dialed before the phone number itself when calling from a mobile phone to a domestic landline phone and vice versa. https://en.wikipedia.org/wiki/Telephone_numbers_in_Colombia https://en.wikipedia.org/wiki/Brazilian_Carrier_Selection_Code

Note this is the "preferred" code, which means other codes may work as well.

{
  "url": string,
  "accessibilityText": string,
  "height": number,
  "width": number
}

string

The source url of the image. Images can be JPG, PNG and GIF (animated and non-animated). For example,https://www.agentx.com/logo.png. Required.

string

A text description of the image to be used for accessibility, e.g. screen readers. Required.

number

The height of the image in pixels. Optional.

number

The width of the image in pixels. Optional.

{
  "id": string,
  "name": string,
  "image": {
    object (Image)
  },
  "phoneNumbers": [
    {
      object (PhoneNumber)
    }
  ],
  "address": {
    object (Location)
  }
}

string

Optional ID assigned to merchant if any.

string

The name of the merchant like "Panera Bread".

object (Image)

The image associated with the merchant.

object (PhoneNumber)

Merchant's phone numbers.

object (Location)

Merchant's address.

{
  "coordinates": {
    object (LatLng)
  },
  "formattedAddress": string,
  "zipCode": string,
  "city": string,
  "postalAddress": {
    object (PostalAddress)
  },
  "name": string,
  "phoneNumber": string,
  "notes": string,
  "placeId": string
}

object (LatLng)

Geo coordinates. Requires the [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] permission.

string

Display address, e.g., "1600 Amphitheatre Pkwy, Mountain View, CA 94043". Requires the [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] permission.

string

Zip code. Requires the [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] or [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION] permission.

string

City. Requires the [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] or [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION] permission.

object (PostalAddress)

Postal address. Requires the [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] or [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION] permission.

string

Name of the place.

string

Phone number of the location, e.g. contact number of business location or phone number for delivery location.

string

Notes about the location.

string

placeId is used with Places API to fetch details of a place. See https://developers.google.com/places/web-service/place-id

{
  "latitude": number,
  "longitude": number
}

number

The latitude in degrees. It must be in the range [-90.0, +90.0].

number

The longitude in degrees. It must be in the range [-180.0, +180.0].

{
  "revision": number,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}

number

The schema revision of the PostalAddress. This must be set to 0, which is the latest revision.

All new revisions must be backward compatible with old revisions.

string

Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.

string

Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations.

If this value is not known, it should be omitted (rather than specifying a possibly incorrect default).

Examples: "zh-Hant", "ja", "ja-Latn", "en".

string

Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).

string

Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

string

Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.

string

Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use addressLines.

string

Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

string

Unstructured address lines describing the lower levels of an address.

Because values in addressLines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language.

The minimum permitted structural representation of an address consists of a regionCode with all remaining information placed in the addressLines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved.

Creating an address only containing a regionCode and addressLines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).

string

Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

string

Optional. The name of the organization at the address.

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

object (LineItem)

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

{
  "id": string,
  "name": string,
  "userVisibleStateLabel": string,
  "provider": {
    object (Merchant)
  },
  "priceAttributes": [
    {
      object (PriceAttribute)
    }
  ],
  "followUpActions": [
    {
      object (Action)
    }
  ],
  "recipients": [
    {
      object (UserInfo)
    }
  ],
  "image": {
    object (Image)
  },
  "description": string,
  "notes": [
    string
  ],
  "disclosures": [
    {
      object (Disclosure)
    }
  ],
  "vertical": {
    "@type": string,
    field1: ...,
    ...
  },

  // Union field verticals can be only one of the following:
  "purchase": {
    object (PurchaseItemExtension)
  },
  "reservation": {
    object (ReservationItemExtension)
  }
  // End of list of possible types for union field verticals.
}

string

Required: Merchant assigned identifier for line item. Used for identifying existing line item in applying partial updates. Max allowed length is 64 chars.

string

Name of line item as displayed on the receipt. Max allowed length is 100 chars.

string

Deprecated. Use vertical level status instead. For example, for purchases, use PurchaseOrderExtension.status. User visible label for the state of this line item.

object (Merchant)

The provider of the particular line item, if different from the overall order. Example: Expedia Order with line item provider ANA.

object (PriceAttribute)

Line item level price and adjustments.

object (Action)

Follow up actions at line item.

object (UserInfo)

Line item level customers, this could be different from Order level buyer. Example: User X made restaurant reservation under name of user Y.

object (Image)

Small image associated with this item, if any.

string

Line item description.

string

Additional notes applicable to this particular line item, for example cancellation policy.

object (Disclosure)

Disclosures associated with this line item.

object

Deprecated: Use verticals instead. Required: Semantic Contents of line item based on its type/vertical. Every vertical should include its own fulfillment details. Must be either one of the following values: google.actions.orders.v3.verticals.purchase.PurchaseItemExtension google.actions.orders.v3.verticals.reservation.ReservationItemExtension google.actions.orders.v3.verticals.ticket.TicketItemExtension

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" }.

object (PurchaseItemExtension)

Purchase orders like goods, food etc.

object (ReservationItemExtension)

Reservation orders like restaurant, haircut etc.

{
  "type": enum (Type),
  "name": string,
  "state": enum (State),
  "taxIncluded": boolean,

  // Union field spec can be only one of the following:
  "amount": {
    object (Money)
  },
  "amountMillipercentage": number
  // End of list of possible types for union field spec.
}

enum (Type)

Required: Type of money attribute.

string

Required: User displayed string of the price attribute. This is sent and localized by merchant.

enum (State)

Required: State of the price: Estimate vs Actual.

boolean

Whether the price is tax included.

object (Money)

Monetary amount.

number

The percentage spec, to 1/1000th of a percent. Eg: 8.750% is represented as 8750, negative percentages represent percentage discounts. Deprecating this field. Can consider adding back when a solid usecase is required.

{
  "currencyCode": string,
  "amountInMicros": string
}

string

The 3-letter currency code defined in ISO 4217.

string (int64 format)

Amount in micros. For example, this field should be set as 1990000 for $1.99.

{
  "type": enum (Type),
  "title": string,
  "openUrlAction": {
    object (OpenUrlAction)
  },
  "actionMetadata": {
    object (ActionMetadata)
  }
}

enum (Type)

Required: Type of action.

string

Title or label of the action, displayed to the user. Max allowed length is 100 chars.

object (OpenUrlAction)

Action to take.

object (ActionMetadata)

Metadata associated with an action.

{
  "url": string,
  "androidApp": {
    object (AndroidApp)
  },
  "urlTypeHint": enum (UrlTypeHint)
}

string

The url field which could be any of: - http/https urls for opening an App-linked App or a webpage

object (AndroidApp)

Information about the Android App if the URL is expected to be fulfilled by an Android App.

enum (UrlTypeHint)

Indicates a hint for the url type.

{
  "packageName": string,
  "versions": [
    {
      object (VersionFilter)
    }
  ]
}

string

Package name Package name must be specified when specifing Android Fulfillment.

object (VersionFilter)

When multiple filters are specified, any filter match will trigger the app.

{
  "minVersion": number,
  "maxVersion": number
}

number

Min version code or 0, inclusive.

number

Max version code, inclusive. The range considered is [minVersion:maxVersion]. A null range implies any version. Examples: To specify a single version use: [target_version:target_version]. To specify any version leave minVersion and maxVersion unspecified. To specify all versions until maxVersion, leave minVersion unspecified. To specify all versions from minVersion, leave maxVersion unspecified.

{
  "expireTime": string
}

string (Timestamp format)

Time when this action will expire.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

{
  "title": string,
  "disclosureText": {
    object (DisclosureText)
  },
  "presentationOptions": {
    object (DisclosurePresentationOptions)
  }
}

string

Title of the disclosure. Example: "Safety information".

object (DisclosureText)

Content of the disclosure. Weblinks are allowed.

object (DisclosurePresentationOptions)

Presentation options for the disclosure.

{
  "template": string,
  "textLinks": [
    {
      object (TextLink)
    }
  ]
}

string

Text to display, containing placeholders like "{0}" and "{1}" for each textlink that should be inserted. Example: "WARNING: This product can expose you to chemicals which are known to the State of California to cause cancer. For more information go to {0}." This disclosure text must not contain any promotional or ad-like content.

object (TextLink)

Text links that should be substituted into the template. The first one will be substituted for "{0}" in the template string, and the second one for "{1}", etc.

{
  "displayText": string,
  "url": string
}

string

Text that should be displayed to users.

string

URL to which users should be directed when the link is activated.

{
  "presentationRequirement": enum (PresentationRequirement),
  "initiallyExpanded": boolean
}

enum (PresentationRequirement)

Presentation requirement of the disclosure.

boolean

Whether the content of the disclosure should be initially expanded. By default, it is initially collapsed.

{
  "status": enum (PurchaseStatus),
  "userVisibleStatusLabel": string,
  "type": enum (PurchaseType),
  "productId": string,
  "quantity": number,
  "unitMeasure": {
    object (MerchantUnitMeasure)
  },
  "returnsInfo": {
    object (PurchaseReturnsInfo)
  },
  "fulfillmentInfo": {
    object (PurchaseFulfillmentInfo)
  },
  "itemOptions": [
    {
      object (ItemOption)
    }
  ],
  "extension": {
    "@type": string,
    field1: ...,
    ...
  },
  "productDetails": {
    object (ProductDetails)
  }
}

enum (PurchaseStatus)

Required: Line item level status.

string

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

enum (PurchaseType)

Required: Type of purchase.

string

Product or offer id associated with this line item.

number

Quantity of the item.

object (MerchantUnitMeasure)

Unit measure. Specifies the size of the item in chosen units. The size, together with the active price is used to determine the unit price.

object (PurchaseReturnsInfo)

Returns info for this line item. If unset, this line item inherits order level returns info.

object (PurchaseFulfillmentInfo)

Fulfillment info for this line item. If unset, this line item inherits order level fulfillment info.

object (ItemOption)

Additional add-ons or sub-items.

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" }.

object (ProductDetails)

Details about the product.

{
  "measure": number,
  "unit": enum (Unit)
}

number

Value: Example 1.2.

enum (Unit)

Unit: Example POUND, GRAM.

{
  "isReturnable": boolean,
  "daysToReturn": number,
  "policyUrl": string
}

boolean

If true, return is allowed.

number

Return is allowed within that many days.

string

Link to the return policy.

{
  "id": string,
  "fulfillmentType": enum (Type),
  "expectedFulfillmentTime": {
    object (Time)
  },
  "expectedPreparationTime": {
    object (Time)
  },
  "location": {
    object (Location)
  },
  "expireTime": string,
  "price": {
    object (PriceAttribute)
  },
  "fulfillmentContact": {
    object (UserInfo)
  },
  "shippingMethodName": string,
  "storeCode": string,
  "pickupInfo": {
    object (PickupInfo)
  }
}

string

Unique identifier for this service option.

enum (Type)

Required: The type of fulfillment.

object (Time)

A window if a time-range is specified or ETA if single time specified. Expected delivery or pickup time.

object (Time)

A window if a time-range is specified or ETA if single time specified. Expected time to prepare the food. Single-time preferred.

object (Location)

Pickup or delivery location.

string (Timestamp format)

Time at which this fulfillment option expires.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

object (PriceAttribute)

Cost of this option.

object (UserInfo)

User contact for this fulfillment.

string

Name of the shipping method selected by the user.

string

StoreCode of the location. Example: Walmart is the merchant and storeCode is the walmart store where fulfillment happened. https://support.google.com/business/answer/3370250?ref_topic=4596653.

object (PickupInfo)

Additional information regarding how order would be picked. This field would only be applicable when fulfillment type is PICKUP.

{
  "timeIso8601": string
}

string

Represents an order-event time like reservation time, delivery time and so on. Could be a duration (start & end time), just the date, date time etc. Refer https://en.wikipedia.org/wiki/ISO_8601 for all supported formats.

{
  "pickupType": enum (PickupType),
  "curbsideInfo": {
    object (CurbsideInfo)
  },
  "checkInInfo": [
    {
      object (CheckInInfo)
    }
  ]
}

enum (PickupType)

Pick up method, such as INSTORE, CURBSIDE etc.

object (CurbsideInfo)

Details specific to the curbside information. If pickupType is not "CURBSIDE", this field would be ignored.

object (CheckInInfo)

List of various methods supported by partner to support check-in.

{
  "curbsideFulfillmentType": enum (CurbsideFulfillmentType),
  "userVehicle": {
    object (Vehicle)
  }
}

enum (CurbsideFulfillmentType)

Partners need additional information to facilitate curbside pickup orders. Depending upon what fulfillment type is chosen, corresponding details would be collected from the user.

object (Vehicle)

Vehicle details of the user placing the order.

{
  "make": string,
  "model": string,
  "licensePlate": string,
  "colorName": string,
  "image": {
    object (Image)
  }
}

string

Vehicle make (e.g. "Honda"). This is displayed to the user and must be localized. Required.

string

Vehicle model (e.g. "Grom"). This is displayed to the user and must be localized. Required.

string

Vehicle license plate number (e.g. "1ABC234"). Required.

string

Vehicle color name, eg. black Optional.

object (Image)

URL to a photo of the vehicle. The photo will be displayed at approximately 256x256px. Must be a jpg or png. Optional.

{
  "checkInType": enum (CheckInType)
}

enum (CheckInType)

Method used to send checkin instructions.

{
  "id": string,
  "name": string,
  "prices": [
    {
      object (PriceAttribute)
    }
  ],
  "note": string,
  "quantity": number,
  "productId": string,
  "subOptions": [
    {
      object (ItemOption)
    }
  ]
}

string

For options that are items, unique item id.

string

Option name.

object (PriceAttribute)

Option total price.

string

Note related to the option.

number

For options that are items, quantity.

string

Product or offer id associated with this option.

object (ItemOption)

To define other nested sub options.

{
  "productId": string,
  "gtin": string,
  "plu": string,
  "productType": string,
  "productAttributes": {
    string: string,
    ...
  }
}

string

Product or offer id associated with this line item.

string

Global Trade Item Number of the product. Useful if offerId is not present in Merchant Center. Optional.

string

Price look-up codes, commonly called PLU codes, PLU numbers, PLUs, produce codes, or produce labels, are a system of numbers that uniquely identify bulk produce sold in grocery stores and supermarkets.

string

Product category defined by the merchant. E.g. "Home > Grocery > Dairy & Eggs > Milk > Whole Milk"

map (key: string, value: string)

Merchant-provided details about the product, e.g. { "allergen": "peanut" }. Useful if offerId is not present in Merchant Center. Optional.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

{
  "status": enum (ReservationStatus),
  "userVisibleStatusLabel": string,
  "type": enum (ReservationType),
  "reservationTime": {
    object (Time)
  },
  "userAcceptableTimeRange": {
    object (Time)
  },
  "confirmationCode": string,
  "partySize": number,
  "staffFacilitators": [
    {
      object (StaffFacilitator)
    }
  ],
  "location": {
    object (Location)
  },
  "extension": {
    "@type": string,
    field1: ...,
    ...
  }
}

enum (ReservationStatus)

Required: Reservation status.

string

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

enum (ReservationType)

Type of reservation. May be unset if none of the type options is applicable.

object (Time)

Time when the service/event is scheduled to occur. Can be a time range, a date, or an exact date time.

object (Time)

Time range that is acceptable to the user.

string

Confirmation code for this reservation.

number

The number of people.

object (StaffFacilitator)

Staff facilitators who will be servicing the reservation. Ex. The hairstylist.

object (Location)

Location of the service/event.

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" }.

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

string

The staff facilitator's name. Ex. "John Smith"

object (Image)

Performer's images.

{
  "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,
  "paymentMethodVoiceName": string
}

enum (PaymentType)

The type of the payment.

string

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

string

Payment method name to be spoken out to the user for voice-only assistant devices. For example, "visa ending in one two three four", or "checking account ending in five six seven eight". Note: This is the voice-optimized string to be used instead of the paymentMethodDisplayName for voice-only assistant devices. If this string is not set, paymentMethodDisplayName will instead be spoken out to the user.

{
  "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": number
}

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.

number

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.