OrderUpdate
Stay organized with collections
Save and categorize content based on your preferences.
UserNotification
Optional user notification to display as part of the Order update.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-18 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["\u003cp\u003e\u003ccode\u003eOrderUpdate\u003c/code\u003e conveys changes to an existing order, encompassing details like order status, user notifications, and the reason for the update.\u003c/p\u003e\n"],["\u003cp\u003eIt utilizes \u003ccode\u003eupdateMask\u003c/code\u003e to specify the fields being modified, offering flexibility and extensibility for various updates.\u003c/p\u003e\n"],["\u003cp\u003eAn optional \u003ccode\u003euserNotification\u003c/code\u003e field enables displaying a message to the user with a designated title and text, enhancing communication.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ereason\u003c/code\u003e field provides context for the update, improving transparency and understanding of order changes.\u003c/p\u003e\n"]]],[],null,["# OrderUpdate\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [UserNotification](#UserNotification)\n - [JSON representation](#UserNotification.SCHEMA_REPRESENTATION)\n\nUpdate to an order.\n\n| JSON representation ||\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"type\": enum (`Type`), \"order\": { object (/assistant/df-asdk/reference/webhook/rest/Shared.Types/Order) }, \"updateMask\": string, \"userNotification\": { object (/assistant/df-asdk/reference/webhook/rest/Shared.Types/OrderUpdate#UserNotification) }, \"reason\": string } ``` |\n\n| Fields ||\n|-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `type` **(deprecated)** | `enum (``Type``)` | This item is deprecated! Deprecated: Use OrderUpdate.update_mask instead. If type = SNAPSHOT, OrderUpdate.order should be the entire order. If type = ORDER_STATUS, this is the order level status change. Only order.last_update_time and this vertical status are picked up. Note: type.ORDER_STATUS only supports PurcahaseOrderExtension status updates and there is no plan to extend this support. Instead, we recommend using updateMask as it is more generic, extensible and can be used for all verticals. |\n| `order` | `object (`[Order](/assistant/df-asdk/reference/webhook/rest/Shared.Types/Order)`)` |\n| `updateMask` | `string (`[FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask)` format)` Note: There are following consideration/recommendations for following special fields: 1. order.last_update_time will always be updated as part of the update request. 2. order.create_time, order.google_order_id and order.merchant_order_id will be ignored if provided as part of the updateMask. A comma-separated list of fully qualified names of fields. Example: `\"user.displayName,photo\"`. |\n| `userNotification` | `object (`[UserNotification](/assistant/df-asdk/reference/webhook/rest/Shared.Types/OrderUpdate#UserNotification)`)` If specified, displays a notification to the user with the specified title and text. Specifying a notification is a suggestion to notify and is not guaranteed to result in a notification. |\n| `reason` | `string` Reason for the change/update. |\n\nUserNotification\n----------------\n\nOptional user notification to display as part of the Order update.\n\n| JSON representation ||\n|---------------------------------------------|---|\n| ``` { \"title\": string, \"text\": string } ``` |\n\n| Fields ||\n|---------|-------------------------------------------------------------------------------|\n| `title` | `string` The title for the user notification. Max allowed length is 30 chars. |\n| `text` | `string` The contents of the notification. Max allowed length is 100 chars. |"]]
