Order

„Order“ (Bestellung) steht für den Inhalt einer laufenden oder abgeschlossenen Bestellung eines Nutzers.

JSON-Darstellung 
{
  "items": [
    {
      object (OrderItem)
    }
  ],
  "metadata": {
    object (OrderMetadata)
  },
  "fulfillment": {
    object (OrderFulfillment)
  },
  "priceInfo": {
    object (OrderPriceInfo)
  },
  "externalOrderId": string
}
Felder
items[]

object (OrderItem)

Optional. Die Artikel in der Bestellung.
metadata

object (OrderMetadata)

Optional. Andere Metadaten, die während der Bestellung erhoben oder abgeleitet werden.
fulfillment

object (OrderFulfillment)

Optional. Die Informationen zur Ausführung der Bestellung.
priceInfo

object (OrderPriceInfo)

Optional. Preisinformationen für den Auftrag.
externalOrderId

string

Nur Ausgabe. Die externe Kennung für diese Bestellung. Wird nur ausgefüllt, wenn eine Point-of-Sale-Integration aktiviert ist.

OrderItem

OrderItem gibt den Status eines Artikels an, der Teil einer Bestellung ist.

JSON-Darstellung 
{
  "uid": string,
  "itemId": string,
  "displayName": string,
  "image": {
    object (Image)
  },
  "basePrice": {
    object (Money)
  },
  "integrationAttributes": {
    object (ItemIntegrationAttributes)
  },
  "modifierGroups": [
    {
      object (OrderModifierGroup)
    }
  ],
  "quantity": integer
}
Felder
uid

string

Optional. Eine vom System zugewiesene eindeutige Kennung für dieses Element.
itemId

string

Erforderlich. Kennung für einen Artikel im Menü, die innerhalb des Menüs eindeutig ist.
displayName

string

Nur Ausgabe. Menschenlesbarer Name für diese Position, der auf Benutzeroberflächen angezeigt werden soll.
image

object (Image)

Nur Ausgabe. Bild, das für dieses Element in der Benutzeroberfläche angezeigt werden soll.
basePrice

object (Money)

Nur Ausgabe. Der Basispreis des Artikels. Dies kann durch die ausgewählten Modifikatoren beeinflusst werden. Das ist der Preis pro Einheit des Artikels.
integrationAttributes

object (ItemIntegrationAttributes)

Nur Ausgabe. Metadaten, die dieser Entität zugeordnet sind und für Downstream-Integrationen verwendet werden.
modifierGroups[]

object (OrderModifierGroup)

Optional. Auf diesen Artikel angewendete ModifierGroups.
quantity

integer

Optional. Die Menge dieses Artikels in der Bestellung.

OrderModifierGroup

OrderModifierGroup gibt den Status einer ModifierGroup an, die Teil eines OrderItem ist.

JSON-Darstellung 
{
  "modifierGroupId": string,
  "displayName": string,
  "integrationAttributes": {
    object (ModifierGroupIntegrationAttributes)
  },
  "modifiers": [
    {
      object (OrderModifier)
    }
  ]
}
Felder
modifierGroupId

string

Erforderlich. Kennung für diese Modifikatorgruppe, die innerhalb des zugehörigen Menüs eindeutig ist.
displayName

string

Nur Ausgabe. Der Name der Modifikatorgruppe, z.B. „Beläge (Sandwich)“ oder „Beilage für mittleres Menü“.
integrationAttributes

object (ModifierGroupIntegrationAttributes)

Nur Ausgabe. Metadaten, die dieser Entität zugeordnet sind und für Downstream-Integrationen verwendet werden.
modifiers[]

object (OrderModifier)

Optional. Die auf diese Modifikatorgruppe angewendeten Modifikatoren.

OrderModifier

OrderModifier gibt den Status eines Attributs an, das Teil einer OrderModifierGroup ist.

JSON-Darstellung 
{
  "uid": string,
  "modifierId": string,
  "displayName": string,
  "priceAdjustment": {
    object (Money)
  },
  "quantity": integer,
  "modifierAction": {
    object (OrderModifierAction)
  },
  "image": {
    object (Image)
  },
  "integrationAttributes": {
    object (ModifierIntegrationAttributes)
  },
  "modifierGroups": [
    {
      object (OrderModifierGroup)
    }
  ]
}
Felder
uid

string

Optional. Eine vom System zugewiesene eindeutige Kennung für diesen Modifikator.
modifierId

string

Erforderlich. Eindeutige Kennung für diesen Modifikator innerhalb des Menüs.
displayName

string

Nur Ausgabe. Der Anzeigename des Modifikators, der auf Benutzeroberflächen angezeigt werden soll.
priceAdjustment

object (Money)

Nur Ausgabe. Die mit diesem Modifikator verknüpfte Preisanpassung (falls vorhanden). Das ist der Preis pro Einheit des Modifikators.
quantity

integer

Optional. Die Menge der angewendeten Modifier-Aktion.
modifierAction

object (OrderModifierAction)

Optional. Die auf diesen Modifikator angewendete Modifikatoraktion.
image

object (Image)

Nur Ausgabe. Bild, das für diesen Modifikator in der Benutzeroberfläche angezeigt werden soll.
integrationAttributes

object (ModifierIntegrationAttributes)

Nur Ausgabe. Metadaten, die dieser Entität zugeordnet sind und für Downstream-Integrationen verwendet werden.
modifierGroups[]

object (OrderModifierGroup)

Optional. Verschachtelte Modifikatorgruppen, die auf diesen Modifikator angewendet werden.

OrderModifierAction

OrderModifierAction gibt die ModifierAction an, die einem angewendeten OrderModifier zugeordnet ist.

JSON-Darstellung 
{
  "name": string
}
Felder
name

string

Optional. Der Name der Modifikatoraktion, z.B. „NO“, „SIDE“, „ADD“, „EXTRA“.

OrderMetadata

OrderMetadata enthält andere Metadaten, die während der Bestellung erhoben oder abgeleitet wurden.

JSON-Darstellung 
{
  "collectedCustomerName": string,
  "callerPhoneNumber": string
}
Felder
collectedCustomerName

string

Optional. Name des Kunden, der bei der Bestellung erfasst wurde. Wird nur ausgefüllt, wenn der Agent so konfiguriert ist, dass er den Namen des Kunden erfasst. Diese Informationen können mündlich erhoben werden und Rechtschreibfehler oder Falschabschriften enthalten.Daher sollten Sie vorsichtig sein, wenn Sie sie Nutzern präsentieren. Sie sollten nicht als Zahlungsinformationen betrachtet werden.
callerPhoneNumber

string

Optional. Die Telefonnummer des Kunden, der die Bestellung aufgibt.

OrderFulfillment

„OrderFulfillment“ enthält Informationen zur Auftragsabwicklung.

JSON-Darstellung 
{
  "fulfillmentMethod": enum (FulfillmentMethod),
  "createTime": string,
  "targetFulfillmentTime": string
}
Felder
fulfillmentMethod

enum (FulfillmentMethod)

Optional. Die Methode zur Ausführung der Bestellung.
createTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem die Bestellung erstellt wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
targetFulfillmentTime

string (Timestamp format)

Optional. Die Zeit, zu der die Bestellung zur Ausführung geplant ist. Wird für „Vorbestellung“ verwendet. Wenn nichts angegeben ist, wird davon ausgegangen, dass die Bestellung „so schnell wie möglich“ erfolgen soll.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

OrderPriceInfo

OrderPriceInfo fasst die verschiedenen Preiskomponenten einer Bestellung zusammen.

JSON-Darstellung 
{
  "totalPrice": {
    object (Money)
  },
  "subtotalPrice": {
    object (Money)
  },
  "taxPrice": {
    object (Money)
  }
}
Felder
totalPrice

object (Money)

Optional. Der endgültige Gesamtpreis nach Anwendung aller Steuern, Gebühren und Rabatte.
subtotalPrice

object (Money)

Optional. Der Zwischensummenpreis aller Artikel und Modifikatoren vor Steuern und Rabatten.
taxPrice

object (Money)

Optional. Der Steuerbetrag, der auf die Bestellung angewendet wurde.