將訂單從 3p 更新為 AOG。如果訂單 ID 空白或不等於現有訂單,則傳回 INVALID_COUNTRY。
HTTP 要求
PATCH https://actions.googleapis.com/v3/orders/{orderUpdate.order.merchantOrderId}
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
orderUpdate.order.merchantOrderId |
必填:商家指派的內部訂單 ID。此 ID 不得重複,而且是後續的訂單更新作業時必填。這個 ID 可以設為提供的 googleOrderId 或任何其他不重複的值。請注意,向使用者顯示的 ID 是 userVisibleOrderId,可能是另一個更易於使用的值。長度上限為 64 個半形字元。 |
要求主體
要求主體的資料會採用以下結構:
JSON 表示法 | |
---|---|
{ "header": { object ( |
欄位 | ||
---|---|---|
header |
更新訂單要求的標題。 |
|
orderUpdate.type |
已淘汰:請改用 OrderUpdate.update_mask。如果類型 = SNAPSHOT,則 OrderUpdate.order 應為整筆訂單。如果類型 = ORDER_STATUS,則會變更訂單層級狀態。只會擷取 order.last_update_time 和此產業狀態。注意:type.ORDER_STATUS 僅支援 PurcahaseOrderExtension 狀態更新,因此目前並未打算延長這項支援。我們建議改用 updateMask,因為不僅更廣泛、更可擴充,也適用於所有產業。 |
|
orderUpdate.order.googleOrderId |
Google 指派的訂單 ID。 |
|
orderUpdate.order.userVisibleOrderId |
參照目前訂單的使用者專屬 ID。在網站、應用程式和電子郵件等其他情況下,這個 ID 應與此訂單顯示的 ID 保持一致。 |
|
orderUpdate.order.userVisibleStateLabel |
已淘汰:請改用 OrderExtensions 狀態。此訂單狀態的使用者可見標籤。 |
|
orderUpdate.order.buyerInfo |
買家相關資訊。 |
|
orderUpdate.order.image |
與訂單相關聯的圖片。 |
|
orderUpdate.order.createTime |
必填:訂單建立的日期和時間。 RFC3339 世界標準時間「Zulu」格式的時間戳記,精確度達奈秒單位,範例: |
|
orderUpdate.order.lastUpdateTime |
上次更新訂單的日期和時間。此為 OrderUpdate 必填屬性。 RFC3339 世界標準時間「Zulu」格式的時間戳記,精確度達奈秒單位,範例: |
|
orderUpdate.order.transactionMerchant |
協助結帳的商家。這可能與委刊項層級供應商設定不同。例如:Expedia Order,內含 ANA 的委刊項。 |
|
orderUpdate.order.contents |
必要:排序一組委刊項的內容。 |
|
orderUpdate.order.priceAttributes[] |
價格、折扣、稅金等。 |
|
orderUpdate.order.followUpActions[] |
依訂單層級的後續追蹤動作。 |
|
orderUpdate.order.paymentData |
訂單的付款相關資料。 |
|
orderUpdate.order.termsOfServiceUrl |
訂單/提案適用的服務條款連結。 |
|
orderUpdate.order.note |
訂單附加的附註。 |
|
orderUpdate.order.promotions[] |
與這筆訂單相關聯的所有促銷活動。 |
|
orderUpdate.order.disclosures[] |
與這筆訂單相關的揭露事項。 |
|
orderUpdate.order.vertical |
已淘汰:請改用產業。除非在某些委刊項中覆寫設定,否則這些屬性會套用至所有委刊項。這個產業必須與委刊項層級產業類型相符。可能的值: 包含任意類型欄位的物件。額外的 |
|
orderUpdate.updateMask |
注意:以下特別欄位應考量/建議:1. order.last_update_time 會在更新要求中一律更新。2. order.create_time、order.google_order_id 和 order.merchant_order_id,若在 updateMask 中提供,則系統會忽略。 以半形逗號分隔的完整欄位名稱清單。範例: |
|
orderUpdate.userNotification |
如果有指定,系統會向使用者顯示指定標題和文字的通知。指定通知是建議通知,不保證一定會收到通知。 |
|
orderUpdate.reason |
變更/更新的原因。 |
|
聯集欄位 verticals 。除非在某些委刊項中覆寫設定,否則這些屬性會套用至所有委刊項。這個產業必須與委刊項層級產業類型相符。verticals 只能是下列其中一項: |
||
orderUpdate.order.purchase |
訂購單 |
|
orderUpdate.order.ticket |
票券訂單 |
回應主體
如果成功,回應主體會包含 Order
的執行例項。
OrderUpdate
更新訂單。
JSON 表示法 | |
---|---|
{ "type": enum ( |
欄位 | |
---|---|
type |
已淘汰:請改用 OrderUpdate.update_mask。如果類型 = SNAPSHOT,則 OrderUpdate.order 應為整筆訂單。如果類型 = ORDER_STATUS,則會變更訂單層級狀態。只會擷取 order.last_update_time 和此產業狀態。注意:type.ORDER_STATUS 僅支援 PurcahaseOrderExtension 狀態更新,因此目前並未打算延長這項支援。我們建議改用 updateMask,因為其功能較為廣泛、具擴充性,且適用於所有產業。 |
order |
|
updateMask |
注意:以下特別欄位應考量/建議:1. order.last_update_time 會在更新要求中一律更新。2. order.create_time、order.google_order_id 和 order.merchant_order_id,若在 updateMask 中提供,則系統會忽略。 以半形逗號分隔的完整欄位名稱清單。範例: |
userNotification |
如果有指定,系統會向使用者顯示指定標題和文字的通知。指定通知是建議通知,不保證一定會收到通知。 |
reason |
變更/更新的原因。 |
類型
已淘汰:請改用 OrderUpdate.update_mask。允許更新訂單。
列舉 | |
---|---|
TYPE_UNSPECIFIED |
未指定類型,不應明確設定這個屬性。 |
ORDER_STATUS |
僅更新訂單狀態。 |
SNAPSHOT |
更新訂單數據匯報。 |
UserNotification
選填的使用者通知,會顯示在訂單更新中。
JSON 表示法 | |
---|---|
{ "title": string, "text": string } |
欄位 | |
---|---|
title |
使用者通知的標題。長度上限為 30 個半形字元。 |
text |
通知的內容。長度上限為 100 個半形字元。 |