Interface Order

Order entity. Note:

All strings at all levels must be less than 1000 chars unless otherwise specified.
All repeated fields at all levels must be less than 50 in count unless otherwise specified.
All timestamps at all levels, if specified, must be valid timestamps.

Hierarchy

Order

Properties

Optional buyerInfo

buyerInfo: UserInfo

Info about the buyer.

Optional contents

contents: Contents

Required: Order contents which is a group of line items.

Optional createTime

createTime: undefined | string

Required: Date and time the order was created.

Optional disclosures

disclosures: Disclosure[]

Disclosures associated with this order.

Optional followUpActions

followUpActions: Action[]

Follow up actions at order level.

Optional googleOrderId

googleOrderId: undefined | string

Google assigned order id.

Optional image

image: V2UIElementsImage

Image associated with the order.

Optional lastUpdateTime

lastUpdateTime: undefined | string

Date and time the order was last updated. Required for OrderUpdate.

Optional merchantOrderId

merchantOrderId: undefined | string

Required: Merchant assigned internal order id. This id must be unique, and is required for subsequent order update operations. This id may be set to the provided google_order_id, or any other unique value. Note that the id presented to users is the user_visible_order_id, which may be a different, more user-friendly value. Max allowed length is 128 chars.

Optional note

note: undefined | string

Notes attached to an order.

Optional paymentData

paymentData: PaymentData

Payment related data for the order.

Optional priceAttributes

priceAttributes: PriceAttribute[]

Price, discounts, taxes and so on.

Optional promotions

promotions: Promotion[]

All promotions that are associated with this order.

Optional purchase

purchase: PurchasePurchaseOrderExtension

Purchase order

Optional termsOfServiceUrl

termsOfServiceUrl: undefined | string

A link to the terms of service that apply to order/proposed order.

Optional ticket

ticket: TicketTicketOrderExtension

Ticket order

Optional transactionMerchant

transactionMerchant: Merchant

Merchant that facilitated the checkout. This could be different from a line item level provider. Example: Expedia Order with line item from ANA.

Optional userVisibleOrderId

userVisibleOrderId: undefined | string

The user facing id referencing to current order. This id should be consistent with the id displayed for this order in other contexts, including websites, apps and email.

Optional userVisibleStateLabel

userVisibleStateLabel: undefined | string

Deprecated: Use OrderExtensions status instead. User visible label for the state of this order.

Optional vertical

vertical: undefined | object

Deprecated: Use verticals instead. These properties will apply to all line items, unless overridden in some line item. This vertical must match the line item level vertical type. Possible values: google.actions.orders.v3.verticals.purchase.PurchaseOrderExtension google.actions.orders.v3.verticals.ticket.TicketOrderExtension