OrderUpdate

  • OrderUpdate conveys changes to an existing order, encompassing details like order status, user notifications, and the reason for the update.

  • It utilizes updateMask to specify the fields being modified, offering flexibility and extensibility for various updates.

  • An optional userNotification field enables displaying a message to the user with a designated title and text, enhancing communication.

  • The reason field provides context for the update, improving transparency and understanding of order changes.

Update to an order.

JSON representation 
{
  "type": enum (Type),
  "order": {
    object (Order)
  },
  "updateMask": string,
  "userNotification": {
    object (UserNotification)
  },
  "reason": string
}
Fields
type
(deprecated)

enum (Type)

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.
order

object (Order)
updateMask

string (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".
userNotification

object (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.
reason

string

Reason for the change/update.

UserNotification

Optional user notification to display as part of the Order update.

JSON representation 
{
  "title": string,
  "text": string
}
Fields
title

string

The title for the user notification. Max allowed length is 30 chars.
text

string

The contents of the notification. Max allowed length is 100 chars.