Method: orders.patch

将订单从第三方更新为 AOG。如果订单的 ID 为空或不等于现有订单，则返回 INVALID_STRING。

HTTP 请求

PATCH https://actions.googleapis.com/v3/orders/{orderUpdate.order.merchantOrderId}

网址采用 gRPC 转码语法。

路径参数

参数
orderUpdate.order.merchantOrderId

string

必填：由商家分配的内部订单 ID。此 ID 必须是唯一的，并且是后续订单更新操作所必需的。此 ID 可以设置为提供的 googleOrderId 或任何其他唯一值。请注意，向用户显示的 ID 是 userVisibleOrderId，该值可能是另一个更方便使用的值。允许的长度上限为 64 个字符。

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "header": {
    object (OrderRequestHeader)
  },
  "orderUpdate": {
    "type": enum (Type),
    "order": {
      "googleOrderId": string,
      "userVisibleOrderId": string,
      "userVisibleStateLabel": string,
      "buyerInfo": {
        object (UserInfo)
      },
      "image": {
        object (Image)
      },
      "createTime": string,
      "lastUpdateTime": string,
      "transactionMerchant": {
        object (Merchant)
      },
      "contents": {
        object (Contents)
      },
      "priceAttributes": [
        {
          object (PriceAttribute)
        }
      ],
      "followUpActions": [
        {
          object (Action)
        }
      ],
      "paymentData": {
        object (PaymentData)
      },
      "termsOfServiceUrl": string,
      "note": string,
      "promotions": [
        {
          object (Promotion)
        }
      ],
      "disclosures": [
        {
          object (Disclosure)
        }
      ],
      "vertical": {
        "@type": string,
        field1: ...,
        ...
      },

      // Union field verticals can be only one of the following:
      "purchase": {
        object (PurchaseOrderExtension)
      },
      "ticket": {
        object (TicketOrderExtension)
      }
      // End of list of possible types for union field verticals.
    },
    "updateMask": string,
    "userNotification": {
      object (UserNotification)
    },
    "reason": string
  }
}
字段
header

object (OrderRequestHeader)

更新订单请求的标头。

orderUpdate.type
(deprecated)

enum (Type)

已弃用：请改用 OrderUpdate.update_mask。如果 type = SNAPSHOT，则 OrderUpdate.order 应为整个订单。如果 type = ORDER_STATUS，则这是订单级状态更改。系统仅提取 order.last_update_time 和此行业状态。注意：type.ORDER_STATUS 仅支持 PurcahaseOrderExtension 状态更新，目前还没有计划扩展此项支持。我们建议使用 updateMask，因为它更通用、可扩展，并且可用于所有行业。
orderUpdate.order.googleOrderId

string

Google 分配的订单 ID。

orderUpdate.order.userVisibleOrderId

string

引用当前订单的面向用户的 ID。此 ID 应与在其他环境（包括网站、应用和电子邮件）中为该订单显示的 ID 一致。

orderUpdate.order.userVisibleStateLabel
(deprecated)

string

已弃用：请改用 OrderExtensions 状态。此订单状态的用户可见标签。

orderUpdate.order.buyerInfo

object (UserInfo)

买方的相关信息。

orderUpdate.order.image

object (Image)

与订单关联的图片。

orderUpdate.order.createTime

string (Timestamp format)

必需：订单的创建日期和时间。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒。示例："2014-10-02T15:01:23.045123456Z"。
orderUpdate.order.lastUpdateTime

string (Timestamp format)

上次更新订单的日期和时间。对于 OrderUpdate 是必需的。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒。示例："2014-10-02T15:01:23.045123456Z"。
orderUpdate.order.transactionMerchant

object (Merchant)

协助完成结账的商家。该提供商可能不同于订单项级提供商。示例：包含来自 ANA 的订单项的 Expedia 订单。

orderUpdate.order.contents

object (Contents)

必需：订单内容，即一组订单项。

orderUpdate.order.priceAttributes[]

object (PriceAttribute)

价格、折扣、税费等。

orderUpdate.order.followUpActions[]

object (Action)

订单级的跟进操作。

orderUpdate.order.paymentData

object (PaymentData)

订单的付款相关数据。

orderUpdate.order.termsOfServiceUrl

string

指向适用于订单/提议订单的服务条款的链接。

orderUpdate.order.note

string

附加到订单的备注。

orderUpdate.order.promotions[]

object (Promotion)

与此订单相关联的所有促销活动。

orderUpdate.order.disclosures[]

object (Disclosure)

与此订单相关的披露信息。

orderUpdate.order.vertical
(deprecated)

object

已弃用：请改用行业。除非这些属性在某些订单项中被替换，否则它们会应用于所有订单项。此行业必须与订单项级行业类型一致。可能的值：google.actions.orders.v3.verticals.purchase.PurchaseOrderExtension google.actions.orders.v3.verticals.ticket.TicketOrderExtension

可以包含任意类型字段的对象。附加字段 "@type" 包含用于标示相应类型的 URI。示例：{ "id": 1234, "@type": "types.example.com/standard/id" }。
orderUpdate.updateMask

string (FieldMask format)

请注意：对于以下特殊字段，请注意以下事项/建议：1. order.last_update_time 将始终作为更新请求的一部分进行更新。2. 如果作为 updateMask 的一部分提供，则 order.create_time、order.google_order_id 和 order.merchant_order_id 将被忽略。

以逗号分隔的完全限定字段名称列表。示例："user.displayName,photo"。
orderUpdate.userNotification

object (UserNotification)

如果指定，则向用户显示包含指定标题和文本的通知。指定通知只是建议用户发送通知，但不保证一定会生成通知。
orderUpdate.reason

string

更改/更新的原因。

联合字段 verticals。除非这些属性在某些订单项中被替换，否则它们会应用于所有订单项。此行业必须与订单项级行业类型一致。verticals 只能是下列其中一项：
orderUpdate.order.purchase

object (PurchaseOrderExtension)

采购订单

orderUpdate.order.ticket

object (TicketOrderExtension)

票券订单

响应正文

如果成功，则响应正文包含一个 Order 实例。

OrderUpdate

更新订单。

JSON 表示法 
{
  "type": enum (Type),
  "order": {
    object (Order)
  },
  "updateMask": string,
  "userNotification": {
    object (UserNotification)
  },
  "reason": string
}
字段
type
(deprecated)

enum (Type)

已弃用：请改用 OrderUpdate.update_mask。如果 type = SNAPSHOT，则 OrderUpdate.order 应为整个订单。如果 type = ORDER_STATUS，则这是订单级状态更改。系统仅提取 order.last_update_time 和此行业状态。注意：type.ORDER_STATUS 仅支持 PurcahaseOrderExtension 状态更新，目前还没有计划扩展此项支持。我们建议使用 updateMask，因为它更通用、可扩展，并且可用于所有行业。
order

object (Order)
updateMask

string (FieldMask format)

请注意：对于以下特殊字段，请注意以下事项/建议：1. order.last_update_time 将始终作为更新请求的一部分进行更新。2. 如果作为 updateMask 的一部分提供，则 order.create_time、order.google_order_id 和 order.merchant_order_id 将被忽略。

以逗号分隔的完全限定字段名称列表。示例："user.displayName,photo"。
userNotification

object (UserNotification)

如果指定，则向用户显示包含指定标题和文本的通知。指定通知只是建议用户发送通知，但不保证一定会生成通知。
reason

string

更改/更新的原因。

类型

已弃用：请改用 OrderUpdate.update_mask。允许对订单进行更新。

枚举
TYPE_UNSPECIFIED 未指定类型，不应明确设置。
ORDER_STATUS 仅更新订单状态。
SNAPSHOT 更新订单快照。

UserNotification

（可选）在订单更新时显示的用户通知。

JSON 表示法 
{
  "title": string,
  "text": string
}
字段
title

string

用户通知的标题。允许的长度上限为 30 个字符。

text

string

通知的内容。允许的长度上限为 100 个字符。