Order

Order は、ユーザーの処理中または完了済みの注文の内容を表します。

JSON 表現 
{
  "items": [
    {
      object (OrderItem)
    }
  ],
  "metadata": {
    object (OrderMetadata)
  },
  "fulfillment": {
    object (OrderFulfillment)
  },
  "priceInfo": {
    object (OrderPriceInfo)
  },
  "externalOrderId": string
}
フィールド
items[]

object (OrderItem)

省略可。注文に含まれる商品。
metadata

object (OrderMetadata)

省略可。注文中に収集または推測されたその他のメタデータ。
fulfillment

object (OrderFulfillment)

省略可。注文のフルフィルメント情報。
priceInfo

object (OrderPriceInfo)

省略可。注文の価格情報。
externalOrderId

string

出力専用。この注文の外部識別子。POS 統合が有効になっている場合にのみ入力されます。

OrderItem

OrderItem は、Order の一部である Item の状態を指定します。

JSON 表現 
{
  "uid": string,
  "itemId": string,
  "displayName": string,
  "image": {
    object (Image)
  },
  "basePrice": {
    object (Money)
  },
  "integrationAttributes": {
    object (ItemIntegrationAttributes)
  },
  "modifierGroups": [
    {
      object (OrderModifierGroup)
    }
  ],
  "quantity": integer
}
フィールド
uid

string

省略可。システムによって割り当てられたこのアイテムの固有識別子。
itemId

string

必須。メニュー内のアイテムの識別子。メニュー内で一意です。
displayName

string

出力専用。ユーザー インターフェースに表示される、この広告申込情報の人が読める名前。
image

object (Image)

出力専用。UI でこの項目に表示する画像。
basePrice

object (Money)

出力専用。商品アイテムの基本価格。これは、選択した修飾子によって影響を受ける可能性があります。これは、アイテムの単価です。
integrationAttributes

object (ItemIntegrationAttributes)

出力専用。ダウンストリーム統合に使用される、このエンティティに関連付けられたメタデータ。
modifierGroups[]

object (OrderModifierGroup)

省略可。このアイテムに適用される ModifierGroups。
quantity

integer

省略可。注文内のこのアイテムの数量。

OrderModifierGroup

OrderModifierGroup は、OrderItem の一部である ModifierGroup の状態を指定します。

JSON 表現 
{
  "modifierGroupId": string,
  "displayName": string,
  "integrationAttributes": {
    object (ModifierGroupIntegrationAttributes)
  },
  "modifiers": [
    {
      object (OrderModifier)
    }
  ]
}
フィールド
modifierGroupId

string

必須。この修飾子グループの識別子。メニュー内で一意です。
displayName

string

出力専用。修飾子グループ名（「トッピング（サンドイッチ）」や「ミディアム コンボのサイド」など）。
integrationAttributes

object (ModifierGroupIntegrationAttributes)

出力専用。ダウンストリーム統合に使用される、このエンティティに関連付けられたメタデータ。
modifiers[]

object (OrderModifier)

省略可。この修飾子グループに適用される修飾子。

OrderModifier

OrderModifier は、OrderModifierGroup の一部である Modifier の状態を指定します。

JSON 表現 
{
  "uid": string,
  "modifierId": string,
  "displayName": string,
  "priceAdjustment": {
    object (Money)
  },
  "quantity": integer,
  "modifierAction": {
    object (OrderModifierAction)
  },
  "image": {
    object (Image)
  },
  "integrationAttributes": {
    object (ModifierIntegrationAttributes)
  },
  "modifierGroups": [
    {
      object (OrderModifierGroup)
    }
  ]
}
フィールド
uid

string

省略可。システムによってこの修飾子に割り当てられる固有識別子。
modifierId

string

必須。この修飾子の識別子。メニュー内で一意です。
displayName

string

出力専用。ユーザー インターフェースに表示される修飾子の表示名。
priceAdjustment

object (Money)

出力専用。この修飾子に関連付けられている価格調整（ある場合）。これは修飾子の単価です。
quantity

integer

省略可。この修飾子アクションが適用された数量。
modifierAction

object (OrderModifierAction)

省略可。この修飾子に適用される修飾子アクション。
image

object (Image)

出力専用。UI でこの修飾子に表示する画像。
integrationAttributes

object (ModifierIntegrationAttributes)

出力専用。ダウンストリーム統合に使用される、このエンティティに関連付けられたメタデータ。
modifierGroups[]

object (OrderModifierGroup)

省略可。この修飾子に適用されるネストされた修飾子グループ。

OrderModifierAction

OrderModifierAction は、適用された OrderModifier に関連付けられた ModifierAction を指定します。

JSON 表現 
{
  "name": string
}
フィールド
name

string

省略可。修飾子の操作名（「NO」、「SIDE」、「ADD」、「EXTRA」など）。

OrderMetadata

OrderMetadata には、注文中に収集または推測されたその他のメタデータが含まれます。

JSON 表現 
{
  "collectedCustomerName": string,
  "callerPhoneNumber": string
}
フィールド
collectedCustomerName

string

省略可。注文時に収集されたお客様の名前。エージェントがお客様の名前を収集するように構成されている場合にのみ、値が入力されます。口頭で収集される場合があり、スペルミスや誤字脱字が含まれている可能性があります。そのため、ユーザーに表示する際は注意が必要です。また、支払い情報などとして信頼すべきではありません。
callerPhoneNumber

string

省略可。注文したお客様の電話番号。

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)
  }
}
フィールド
totalPrice

object (Money)

省略可。すべての税金、手数料、割引が適用された後の最終的な合計価格。
subtotalPrice

object (Money)

省略可。税金と割引を適用する前の、すべての商品と修飾子の小計価格。
taxPrice

object (Money)

省略可。注文に適用された税額。