Page Summary
-
This content describes the deprecated Orders version 2 API.
-
Users should refer to the migration guide for moving existing Actions with transactions to Orders version 3.
-
The page details the structure and fields of the
TransactionDecisionValueobject returned to the app. -
It also outlines the
TransactionRequirementsCheckResult,Order,PaymentInfo,GoogleProvidedPaymentInstrument, andCustomerInfoobjects related to transactions.
- JSON representation
- TransactionRequirementsCheckResult
- Order
- PaymentInfo
- GoogleProvidedPaymentInstrument
- CustomerInfo
Next Id: 6 Returned to the app as output for actions.intent.TRANSACTION_DECISION.
| JSON representation | |
|---|---|
{ "checkResult": { object( |
|
| Fields | |
|---|---|
checkResult |
If |
userDecision |
User decision regarding the proposed order. |
order |
The order that user has approved. This field will be present only when |
deliveryAddress |
If user requests for delivery address update, this field includes the new delivery address. This field will be present only when |
TransactionRequirementsCheckResult
Returned to the app as output for actions.intent.TRANSACTION_REQUIREMENTS_CHECK.
| JSON representation | |
|---|---|
{
"resultType": enum( |
|
| Fields | |
|---|---|
resultType |
Result of the operation. |
Order
Confirmed order with payment details, if requested. Sent to agent.
| JSON representation | |
|---|---|
{ "finalOrder": { object( |
|
| Fields | |
|---|---|
finalOrder |
Reflect back the proposed order that caused the order. |
googleOrderId |
Order id assigned by Google. |
orderDate |
Date and time the order was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: |
paymentInfo |
Payment related info for the order. |
actionOrderId |
User-visible order id. Must be set on the initial synchronous OrderUpdate/confirmation. |
customerInfo |
If requested, customer info e.g. email will be passed back to the app. |
PaymentInfo
Payment related info for an order.
| JSON representation | |
|---|---|
{ "paymentType": enum( |
|
| Fields | |
|---|---|
paymentType |
Type of payment. Required. |
displayName |
Name of the instrument displayed on the receipt. |
googleProvidedPaymentInstrument |
Google provided payment instrument. |
GoogleProvidedPaymentInstrument
Google provided payment instrument.
| JSON representation | |
|---|---|
{
"instrumentToken": string,
"billingAddress": {
object( |
|
| Fields | |
|---|---|
instrumentToken |
Google provided payment instrument. A base64-encoded string. |
billingAddress |
If requested by integrator, billing address for the instrument in use will be included. |
CustomerInfo
Information about customer.
| JSON representation | |
|---|---|
{ "email": string } |
|
| Fields | |
|---|---|
email |
Customer email will be included and returned to the app if CustomerInfoProperty.EMAIL specified in CustomerInfoOptions. |