Order

ההזמנה מייצגת את התוכן של הזמנה שהמשתמש מבצע או השלים.

ייצוג ב-JSON 
{
  "items": [
    {
      object (OrderItem)
    }
  ],
  "metadata": {
    object (OrderMetadata)
  },
  "fulfillment": {
    object (OrderFulfillment)
  },
  "priceInfo": {
    object (OrderPriceInfo)
  },
  "externalOrderId": string,
  "orderPayment": {
    object (OrderPayment)
  }
}
שדות
items[]

object (OrderItem)

זה שינוי אופציונלי. הפריטים בהזמנה.
metadata

object (OrderMetadata)

זה שינוי אופציונלי. מטא-נתונים אחרים שנאספים או נגזרים במהלך ההזמנה.
fulfillment

object (OrderFulfillment)

זה שינוי אופציונלי. פרטי האספקה של ההזמנה.
priceInfo

object (OrderPriceInfo)

זה שינוי אופציונלי. מידע על המחיר של ההזמנה.
externalOrderId

string

פלט בלבד. המזהה החיצוני של ההזמנה הזו. השדה הזה מאוכלס רק אם מופעל שילוב של מערכת לניהול נקודות מכירה.
orderPayment

object (OrderPayment)

זה שינוי אופציונלי. סטטוס התשלום שמשויך להזמנה הזו.

OrderItem

המאפיין OrderItem מציין את הסטטוס של פריט שכלול בהזמנה.

ייצוג ב-JSON 
{
  "uid": string,
  "itemId": string,
  "displayName": string,
  "image": {
    object (Image)
  },
  "basePrice": {
    object (Money)
  },
  "integrationAttributes": {
    object (ItemIntegrationAttributes)
  },
  "modifierGroups": [
    {
      object (OrderModifierGroup)
    }
  ],
  "quantity": integer,
  "totalPrice": {
    object (Money)
  },
  "categoryIds": [
    string
  ]
}
שדות
uid

string

זה שינוי אופציונלי. מזהה ייחודי שמוקצה לפריט על ידי המערכת.
itemId

string

חובה. מזהה של פריט בתפריט, ייחודי לתפריט.
displayName

string

פלט בלבד. שם קריא לאנשים של הפריט הזה, שיוצג בממשקי משתמש.
image

object (Image)

פלט בלבד. התמונה שתוצג לפריט הזה בממשק המשתמש.
basePrice

object (Money)

פלט בלבד. המחיר הבסיסי של הפריט. יכול להיות שההשפעה תהיה שונה בהתאם למשני המיקום שנבחרו. המחיר ליחידה של הפריט.
integrationAttributes

object (ItemIntegrationAttributes)

פלט בלבד. מטא-נתונים שמשויכים לישות הזו ומשמשים לשילובים במורד הזרם.
modifierGroups[]

object (OrderModifierGroup)

זה שינוי אופציונלי. קבוצות של משנים שהוחלו על הפריט הזה.
quantity

integer

זה שינוי אופציונלי. הכמות של הפריט הזה בהזמנה.
totalPrice

object (Money)

פלט בלבד. המחיר הכולל של פריט השורה הזה, כולל שינויים שנבחרו ובהתאם לכמות הפריטים, לפני מס. משמש להצגת פרטי הפריט בעגלת הקניות.
categoryIds[]

string

פלט בלבד. מזהי הקטגוריות שהפריט בתפריט משויך אליהן. משקף את Item.category_ids בתפריט, כדי שהלקוחות יוכלו לקבץ פריטים שהוזמנו לפי קטגוריית התפריט.

OrderModifierGroup

‫OrderModifierGroup מציין את הסטטוס של ModifierGroup שהוא חלק מ-OrderItem.

ייצוג ב-JSON 
{
  "modifierGroupId": string,
  "displayName": string,
  "integrationAttributes": {
    object (ModifierGroupIntegrationAttributes)
  },
  "modifiers": [
    {
      object (OrderModifier)
    }
  ]
}
שדות
modifierGroupId

string

חובה. מזהה של קבוצת המשנים הזו, ייחודי בתפריט שלה.
displayName

string

פלט בלבד. השם של קבוצת התוספות – לדוגמה, 'תוספות (כריך)' או 'תוספת לארוחה בינונית'.
integrationAttributes

object (ModifierGroupIntegrationAttributes)

פלט בלבד. מטא-נתונים שמשויכים לישות הזו ומשמשים לשילובים במורד הזרם.
modifiers[]

object (OrderModifier)

זה שינוי אופציונלי. המשנים שחלים על קבוצת המשנים הזו.

OrderModifier

‫OrderModifier מציין את המצב של Modifier שהוא חלק מ-OrderModifierGroup.

ייצוג ב-JSON 
{
  "uid": string,
  "modifierId": string,
  "displayName": string,
  "priceAdjustment": {
    object (Money)
  },
  "quantity": integer,
  "modifierAction": {
    object (OrderModifierAction)
  },
  "image": {
    object (Image)
  },
  "integrationAttributes": {
    object (ModifierIntegrationAttributes)
  },
  "modifierGroups": [
    {
      object (OrderModifierGroup)
    }
  ],
  "isDefault": boolean
}
שדות
uid

string

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

string

חובה. מזהה של התוסף הזה, ייחודי בתפריט.
displayName

string

פלט בלבד. השם לתצוגה של המגביל שיוצג בממשקי המשתמש.
priceAdjustment

object (Money)

פלט בלבד. התאמת המחיר שמשויכת לשינוי הזה, אם יש. המחיר ליחידה של התוסף.
quantity

integer

זה שינוי אופציונלי. הכמות של פעולת השינוי הזו שהוחלה.
modifierAction

object (OrderModifierAction)

זה שינוי אופציונלי. פעולת ה-modifier שחלה על ה-modifier הזה.
image

object (Image)

פלט בלבד. התמונה שתוצג לשינוי הזה בממשק המשתמש.
integrationAttributes

object (ModifierIntegrationAttributes)

פלט בלבד. מטא-נתונים שמשויכים לישות הזו ומשמשים לשילובים במורד הזרם.
modifierGroups[]

object (OrderModifierGroup)

זה שינוי אופציונלי. קבוצות משנים מוטמעות שחלות על המשנה הזה.
isDefault

boolean

פלט בלבד. האם התוסף הזה הוא בחירת ברירת מחדל לקבוצת התוספים שלו. הפרמטר הזה נדרש כדי שהלקוחות יוכלו לחשב את ההבדל המדויק בין הבחירות.

OrderModifierAction

‫OrderModifierAction מציין את ה-ModifierAction שמשויך ל-OrderModifier שהוחל.

ייצוג ב-JSON 
{
  "name": string
}
שדות
name

string

זה שינוי אופציונלי. שם פעולת התוסף – למשל, 'לא', 'צדדי', 'הוספה', 'תוספת'.

OrderMetadata

האובייקט OrderMetadata מכיל מטא-נתונים אחרים שנאספו או שהוסקו במהלך ההזמנה.

ייצוג ב-JSON 
{
  "collectedCustomerName": string,
  "callerPhoneNumber": string,
  "deliveryAddress": {
    object (DeliveryAddress)
  }
}
שדות
collectedCustomerName

string

זה שינוי אופציונלי. שם הלקוח, שנאסף בזמן ביצוע ההזמנה. השדה הזה מאוכלס רק אם הסוכן מוגדר לאסוף את שם הלקוח. יכול להיות שהמידע הזה ייאסף בעל פה, והוא עשוי להכיל שגיאות כתיב או שגיאות בתמלול. לכן חשוב לנקוט משנה זהירות כשמציגים אותו למשתמשים, ואין להסתמך עליו כמו על פרטי תשלום, למשל.
callerPhoneNumber

string

זה שינוי אופציונלי. מספר הטלפון של הלקוח שמבצע את ההזמנה.
deliveryAddress

object (DeliveryAddress)

זה שינוי אופציונלי. הכתובת למשלוח, אם ההזמנה היא הזמנה למשלוח.

DeliveryAddress

הכתובת למשלוח של ההזמנה. יכול להיות שזו כתובת קיימת שנשמרה או נאספה.

ייצוג ב-JSON 
{
  "address": {
    object (PostalAddress)
  },
  "validationStatus": enum (ValidationStatus),
  "coordinates": {
    object (LatLng)
  }
}
שדות
address

object (PostalAddress)

זה שינוי אופציונלי. הכתובת למשלוח.
validationStatus

enum (ValidationStatus)

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

object (LatLng)

זה שינוי אופציונלי. הקואורדינטות הגיאוגרפיות של הכתובת. המאפיין משמש לאימות הכתובת כדי לוודא שהיא נמצאת בטווח המשלוחים של החנות.

ValidationStatus

סטטוס האימות של הכתובת למשלוח. הוא נקבע לפי לוגיקת אימות ספציפית ללקוח.

טיפוסים בני מנייה (enum)
VALIDATION_STATUS_UNSPECIFIED הכתובת עדיין לא אומתה.
VALIDATION_STATUS_VALID הכתובת תקינה.
VALIDATION_STATUS_INVALID הכתובת לא תקינה (לא קיימת, אי אפשר לנתח אותה וכו')
VALIDATION_STATUS_OUT_OF_RANGE הכתובת קיימת והיא נפתרה, אבל היא לא נמצאת בטווח של החנות.
VALIDATION_STATUS_INCOMPLETE_ADDRESS בכתובת חסרים שדות חובה (חסרים מספר בית או שם רחוב, עיר, מדינה, מיקוד וכו')

OrderFulfillment

האלמנט OrderFulfillment מכיל מידע על אספקת הזמנות.

ייצוג ב-JSON 
{
  "fulfillmentMethod": enum (FulfillmentMethod),
  "createTime": string,
  "targetFulfillmentTime": string
}
שדות
fulfillmentMethod

enum (FulfillmentMethod)

זה שינוי אופציונלי. שיטת האספקה של ההזמנה.
createTime

string (Timestamp format)

פלט בלבד. השעה שבה ההזמנה נוצרה.

הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
targetFulfillmentTime

string (Timestamp format)

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

הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".

OrderPriceInfo

האובייקט OrderPriceInfo מכיל את רכיבי המחיר השונים של הזמנה.

ייצוג ב-JSON 
{
  "totalPrice": {
    object (Money)
  },
  "subtotalPrice": {
    object (Money)
  },
  "taxPrice": {
    object (Money)
  },
  "discount": {
    object (Money)
  },
  "saving": {
    object (Money)
  },
  "fees": {
    object (Money)
  }
}
שדות
totalPrice

object (Money)

זה שינוי אופציונלי. המחיר הכולל הסופי אחרי כל המיסים, העמלות וההנחות.
subtotalPrice

object (Money)

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

object (Money)

זה שינוי אופציונלי. סכום המס שחל על ההזמנה.
discount

object (Money)

זה שינוי אופציונלי. ההנחה הכוללת שחלה על ההזמנה
saving

object (Money)

זה שינוי אופציונלי. הנחה על מבצע שמוחלת על ההזמנה
fees

object (Money)

זה שינוי אופציונלי. סך העמלות שחלות על ההזמנה

OrderPayment

הפרטים שקשורים לתשלום על הזמנה.

ייצוג ב-JSON 
{
  "tippingInfo": {
    object (TippingInfo)
  },
  "loyaltyConsumed": {
    object (LoyaltyAmount)
  },
  "paymentInfo": {
    object (PaymentInfo)
  }
}
שדות
tippingInfo

object (TippingInfo)

זה שינוי אופציונלי. פרטי הטיפ.
loyaltyConsumed

object (LoyaltyAmount)

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

object (PaymentInfo)

זה שינוי אופציונלי. מידע על אמצעי התשלום שבו נעשה שימוש.

TippingInfo

מידע על מתן טיפים

ייצוג ב-JSON 
{

  // Union field tip_type can be only one of the following:
  "amount": {
    object (Money)
  },
  "percentageBps": integer
  // End of list of possible types for union field tip_type.
}
שדות
שדה איחוד tip_type. סכום הטיפ או אחוז הטיפ. הערך tip_type יכול להיות רק אחד מהבאים:
amount

object (Money)

זה שינוי אופציונלי. סכום כסף ספציפי לטיפ.
percentageBps

integer

זה שינוי אופציונלי. אחוז בנקודות בסיס, לדוגמה, 450 = 4.5%.

LoyaltyAmount

מייצג את סכום הנאמנות של הלקוח.

ייצוג ב-JSON 
{
  "units": string
}
שדות
units

string (int64 format)

חובה. נקודות המועדון.

PaymentInfo

פרטי התשלום של המשתמש.

ייצוג ב-JSON 
{
  "creditCardLastFourDigits": string,
  "creditCardCvv": string,
  "paymentMethod": enum (PaymentMethod)
}
שדות
creditCardLastFourDigits

string

זה שינוי אופציונלי. ארבע הספרות האחרונות של כרטיס האשראי. הוא משמש לאימות מספר כרטיס האשראי בשלב התשלום.
creditCardCvv

string

זה שינוי אופציונלי. קוד האימות (CVV) של כרטיס האשראי.
paymentMethod

enum (PaymentMethod)

זה שינוי אופציונלי. סוג אמצעי התשלום ששימש לביצוע העסקה.

PaymentMethod

סוג אמצעי התשלום.

טיפוסים בני מנייה (enum)
PAYMENT_METHOD_UNSPECIFIED אמצעי התשלום לא צוין.
PAYMENT_METHOD_CREDIT_CARD כרטיס אשראי.
PAYMENT_METHOD_CASH מזומן.