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)

זה שינוי אופציונלי. פעולת השינוי שהוחלה על השינוי הזה.
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 מזומן.