ClientExecutionResult

The result of a client execution request.

JSON representation
{
  "executionId": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "finalizeOrderResponse": {
    object (FinalizeOrderResponse)
  },
  "orderPricesResponse": {
    object (OrderPricesResponse)
  },
  "validateDeliveryAddressResponse": {
    object (ValidateDeliveryAddressResponse)
  },
  "orderStatusResponse": {
    object (OrderStatusResponse)
  }
  // End of mutually exclusive fields.
}
Fields
executionId

string

Required. The ID of the execution request this is a result for.

The specific result of the execution. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
finalizeOrderResponse

object (FinalizeOrderResponse)

The result of finalizing the order.

orderPricesResponse

object (OrderPricesResponse)

The result of getting the order prices.

validateDeliveryAddressResponse

object (ValidateDeliveryAddressResponse)

The result of validating the delivery address.

orderStatusResponse

object (OrderStatusResponse)

The result of getting the order status.

End of mutually exclusive fields.

FinalizeOrderResponse

The result of finalizing the order.

JSON representation
{
  "paymentFlowEnabled": boolean,
  "paymentInfo": {
    object (PaymentInfo)
  },
  "totalAmountDue": {
    object (Money)
  },
  "orderPriceInfo": {
    object (OrderPriceInfo)
  }
}
Fields
paymentFlowEnabled

boolean

Optional. Whether to enable the payment handling flow in the agent.

paymentInfo

object (PaymentInfo)

Optional. The payment information of the customer. No-op if paymentFlowEnabled is false. Only creditCardLastFourDigits and paymentMethod should be populated here; raw cardholder or sensitive authentication data must never be included.

totalAmountDue

object (Money)

Optional. The total amount due for the order.

orderPriceInfo

object (OrderPriceInfo)

Optional. The detailed price information of the order.

OrderPricesResponse

The result of getting the order prices.

JSON representation
{
  "success": boolean,
  "orderPriceInfo": {
    object (OrderPriceInfo)
  }
}
Fields
success

boolean

Required. Whether the order prices were successfully retrieved.

orderPriceInfo

object (OrderPriceInfo)

Optional. Total order price after all discounts, fees, taxes, etc

ValidateDeliveryAddressResponse

The result of validating a delivery address.

JSON representation
{
  "success": boolean,
  "validationStatus": enum (ValidationStatus),
  "validDeliveryStores": [
    {
      object (ValidDeliveryStore)
    }
  ]
}
Fields
success

boolean

Required. Whether or not the validation completed without error.

validationStatus

enum (ValidationStatus)

Required. The validation status of the delivery address.

validDeliveryStores[]

object (ValidDeliveryStore)

Optional. The list of valid stores that can deliver to the original delivery address. This should only be populated when the validation status is VALIDATION_STATUS_OUT_OF_RANGE. And will be ignored otherwise.

ValidDeliveryStore

A store that can deliver to the specified delivery address.

JSON representation
{
  "store": string
}
Fields
store

string

Required. The store that can deliver to the address. Format: projects/{project}/locations/{location}/brands/{brand}/stores/{store}

OrderStatusResponse

The result of getting the order status.

JSON representation
{
  "success": boolean
}
Fields
success

boolean

Required. Whether the order status was successfully retrieved.