Method: orders.patch

עדכון ההזמנה מ-3p ל-AOG. מחזירה INVALID_:** אם מזהה ההזמנה הוא ריק או לא שווה להזמנה קיימת.

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.

פרמטרים של נתיב

פרמטרים
orderUpdate.order.merchantOrderId

string

חובה: מזהה הזמנה פנימי שהוקצה על ידי המוכר. המזהה הזה צריך להיות ייחודי, והוא נדרש לפעולות הבאות של עדכון הזמנה. אפשר להגדיר את המזהה הזה ל-googleOrderId שצוין או לכל ערך ייחודי אחר. שימו לב שהמזהה שמוצג למשתמשים הוא 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 במקום זאת. אם הסוג = SNAPSHOT, יש לציין את OrderUpdate.order בכל ההזמנה. אם הסוג = ORDER_STATUS, זהו השינוי בסטטוס של רמת ההזמנה. אנחנו אוספים רק את הפרמטר order.last_update_time והסטטוס האנכי הזה. הערה: type.ORDER_STATUS תומך רק בעדכוני סטטוס של ForcahaseOrderExtension ואנחנו לא מתכננים להרחיב את התמיכה הזו. במקום זאת, מומלץ להשתמש ב-updateMask כי הוא כללי יותר, ניתן להרחבה וניתן להשתמש בו לכל הענפים.

orderUpdate.order.googleOrderId

string

מזהה ההזמנה שהוקצה על ידי Google.

orderUpdate.order.userVisibleOrderId

string

המזהה שגלוי למשתמש שמתייחס להזמנה הנוכחית. המזהה הזה צריך להיות תואם למזהה שמוצג בהזמנה הזו בהקשרים אחרים, כולל אתרים, אפליקציות ואימייל.

orderUpdate.order.userVisibleStateLabel
(deprecated)

string

הוצא משימוש: יש להשתמש בסטטוס של תוספי הזמנה. תווית גלויה למשתמש של מצב ההזמנה הזו.

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)

המוכר שאפשר את התשלום בקופה. הספק יכול להיות שונה מספק ברמת הפריט. דוגמה: הזמנת Expedia עם פריט מ-ANA.

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 במקום זאת. אם הסוג = SNAPSHOT, יש לציין את OrderUpdate.order בכל ההזמנה. אם הסוג = ORDER_STATUS, זהו השינוי בסטטוס של רמת ההזמנה. אנחנו אוספים רק את הפרמטר order.last_update_time והסטטוס האנכי הזה. הערה: type.ORDER_STATUS תומך רק בעדכוני סטטוס של ForcahaseOrderExtension ואנחנו לא מתכננים להרחיב את התמיכה הזו. במקום זאת, מומלץ להשתמש ב-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 במקום זאת. אפשרו עדכונים להזמנה.

טיפוסים בני מנייה (enums)
TYPE_UNSPECIFIED הסוג לא צוין, אין להגדיר זאת במפורש.
ORDER_STATUS יש לעדכן רק את סטטוס ההזמנה.
SNAPSHOT עדכון תמונת המצב של ההזמנה.

UserNotification

הודעה אופציונלית שתוצג למשתמש כחלק מעדכון ההזמנה.

ייצוג JSON 
{
  "title": string,
  "text": string
}
שדות
title

string

הכותרת של התראת המשתמש. האורך המקסימלי המותר הוא 30 תווים.

text

string

תוכן ההודעה. האורך המקסימלי המותר הוא 100 תווים.