Method: orders.patch

将订单从 3p 更新为 AOG。如果订单 ID 为空或不等于现有订单,则返回 INVALID_ARGUMENT。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
orderUpdate.order.merchantOrderId

string

必填:商家分配的内部订单 ID。此 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. 如果 order.create_time、order.google_order_id 和 order.merchant_order_id 作为 updateMask 的一部分提供,则将被忽略。

以逗号分隔的完全限定字段名称列表。示例:"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. 如果 order.create_time、order.google_order_id 和 order.merchant_order_id 作为 updateMask 的一部分提供,则将被忽略。

以逗号分隔的完全限定字段名称列表。示例:"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 个字符。