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 は、注文の一部であるアイテムの状態を指定します。

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)

出力専用。UI でこのアイテムに表示する画像。
basePrice

object (Money)

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

object (ItemIntegrationAttributes)

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

object (OrderModifierGroup)

省略可。この商品に適用される ModifierGroup。
quantity

integer

省略可。注文に含まれるこのアイテムの数量。
totalPrice

object (Money)

出力専用。この項目の合計金額（選択した修飾子を含み、商品数量を反映した税抜きの金額）。商品ごとのバッグの表示に使用されます。
categoryIds[]

string

出力専用。基になるメニュー項目が属するカテゴリ ID。メニューの Item.category_ids をミラーリングして、クライアントが注文されたアイテムをメニュー カテゴリ別にグループ化できるようにします。

OrderModifierGroup

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

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

string

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

string

出力専用。修飾子グループの名前（例: 「トッピング（サンドイッチ）」、「M サイズ コンボのサイドメニュー」）。
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)
    }
  ],
  "isDefault": boolean
}
フィールド
uid

string

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

string

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

string

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

object (Money)

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

integer

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

object (OrderModifierAction)

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

object (Image)

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

object (ModifierIntegrationAttributes)

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

object (OrderModifierGroup)

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

boolean

出力専用。この修飾子が修飾子グループのデフォルトの選択肢であるかどうか。クライアントが正確な選択差分を計算できるようにするために必要です。

OrderModifierAction

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

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

string

省略可。修飾子のアクション名（例: 「NO」、「SIDE」、「ADD」、「EXTRA」）。

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

お届け先住所の検証ステータス。これは、クライアント固有の検証ロジックによって決定されます。

列挙型
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)

省略可。注文に適用された手数料の合計