系統會在使用者建立購物車時叫用結帳程序。使用者購物車的內容和訂單詳細資料會傳送至「Google 訂餐」網路服務。這項資訊是由您的網路服務來驗證,然後您可以視需要進行或調整購物車。
網路服務的結帳處理常式必須回應 POST 要求。當客戶選擇結帳時,Google 會以 CheckoutRequestMessage
的形式傳送「透過 Google 訂餐」網路服務,其中包含客戶Cart
的詳細資料。然後您的網路服務會傳回 CheckoutResponseMessage
。下圖說明程序。
收到結帳要求後,「Google 訂餐」網路服務必須執行下列步驟:
- 根據目前的商品價格、供應情形和供應商服務,檢查購物車的有效性。
- 計算總價 (包括任何折扣、稅金和運費)。
- 如果成功,請回覆未經修改的購物車。
- 如果失敗,系統會傳回錯誤訊息和新的提案訂單。
開始實作結帳功能之前,建議您先詳閱執行總覽總覽說明文件。
結帳要求訊息
為了驗證客戶的購物車,當客戶選擇結帳時,Google 會以 CheckoutRequestMessage
格式以 JSON 主體向網路服務傳送要求。在「Google 訂餐」流程中,系統不會提交客戶訂單。
CheckoutRequestMessage
中的資料包括:
- 意圖:每個結帳要求主體的
inputs[0].intent
欄位都包含actions.foodordering.intent.CHECKOUT
字串值。 - 購物車:結帳要求的
inputs[0].arguments[0].extension
欄位包含Cart
物件,代表客戶的購物車。 - 提交或外帶:
Cart
物件的擴充功能欄位包含FoodCartExtension
物件,用於指定外送或外帶屬性:- 如果是交付訂單,
FoodCartExtension
物件包含寄送地址。 - 如為自取或外帶訂單,
FoodCartExtension
物件不含任何地點資訊。
- 如果是交付訂單,
- 沙箱:結帳要求的
isInSandbox
欄位含有布林值,指出交易是否使用沙箱付款。
結帳要求示例
以下是 CheckoutRequestMessage
的範例:
{
"user": {},
"conversation": {
"conversationId": "CTZbZfUlHCybEdcz_5PB3Ttf"
},
"inputs": [
{
"intent": "actions.foodordering.intent.CHECKOUT",
"arguments": [
{
"extension": {
"@type": "type.googleapis.com/google.actions.v2.orders.Cart",
"merchant": {
"id": "restaurant/Restaurant/QWERTY",
"name": "Tep Tep Chicken Club"
},
"lineItems": [
{
"name": "Spicy Fried Chicken",
"type": "REGULAR",
"id": "299977679",
"quantity": 2,
"price": {
"type": "ESTIMATE",
"amount": {
"currencyCode": "AUD",
"units": "39",
"nanos": 600000000
}
},
"offerId": "MenuItemOffer/QWERTY/scheduleId/496/itemId/143",
"extension": {
"@type": "type.googleapis.com/google.actions.v2.orders.FoodItemExtension"
}
}
],
"extension": {
"@type": "type.googleapis.com/google.actions.v2.orders.FoodCartExtension",
"fulfillmentPreference": {
"fulfillmentInfo": {
"delivery": {
"deliveryTimeIso8601": "P0M"
}
}
},
"location": {
"coordinates": {
"latitude": -33.8376441,
"longitude": 151.0868736
},
"formattedAddress": "Killoola St, 1, Concord West NSW 2138",
"zipCode": "2138",
"city": "Concord West",
"postalAddress": {
"regionCode": "AU",
"postalCode": "2138",
"administrativeArea": "NSW",
"locality": "Concord West",
"addressLines": [
"Killoola St",
"1"
]
}
}
}
}
}
]
}
],
"directActionOnly": true,
"isInSandbox": true
}
結帳回應訊息
收到「Google 訂餐」的要求後,您的結帳網路服務必須處理要求並透過 CheckoutResponseMessage
回應。CheckoutResponseMessage
必須涵蓋成功或失敗的要求。
成功的要求
如果結帳要求成功,CheckoutResponseMessage
必須包含 ProposedOrder
和 PaymentOptions
:
ProposedOrder
cart
:cart
物件,與CheckoutRequestMessage
中提供的購物車完全相同。如果購物車的任何內容需要變更,CheckoutResponseMessage
會改為加入具有正確ProposedOrder
的FoodErrorExtension
。otherItems
:供應商新增的項目,例如運費、稅金和其他費用。也可能包含使用者添加的重力。totalPrice
:訂單總費用。extension
:定義訂單出貨資訊的FoodOrderExtension
,例如運送時間。
PaymentOptions
- 我們稍後會在設定 Google Pay 中說明如何設定付款處理流程。您可以在準備好實作付款處理之前,在
CheckoutResponseMessage
中使用預留位置 JSON。 - 如要在
CheckoutResponseMessage
中新增預留位置付款選項,請參閱下方的範例。這個範例使用PaymentOptions
的付款閘道。
- 我們稍後會在設定 Google Pay 中說明如何設定付款處理流程。您可以在準備好實作付款處理之前,在
成功回應範例
{
"finalResponse": {
"richResponse": {
"items": [
{
"structuredResponse": {
"checkoutResponse": {
"proposedOrder": {
"cart": {
"merchant": {
"id": "restaurant/Restaurant/QWERTY",
"name": "Tep Tep Chicken Club"
},
"lineItems": [
{
"name": "Spicy Fried Chicken",
"type": "REGULAR",
"id": "299977679",
"quantity": 2,
"price": {
"type": "ESTIMATE",
"amount": {
"currencyCode": "AUD",
"units": "39",
"nanos": 600000000
}
},
"offerId": "MenuItemOffer/QWERTY/scheduleId/496/itemId/143",
"extension": {
"@type": "type.googleapis.com/google.actions.v2.orders.FoodItemExtension"
}
}
],
"extension": {
"@type": "type.googleapis.com/google.actions.v2.orders.FoodCartExtension",
"fulfillmentPreference": {
"fulfillmentInfo": {
"delivery": {
"deliveryTimeIso8601": "P0M"
}
}
},
"location": {
"coordinates": {
"latitude": -33.8376441,
"longitude": 151.0868736
},
"formattedAddress": "Killoola St, 1, Concord West NSW 2138",
"zipCode": "2138",
"city": "Concord West",
"postalAddress": {
"regionCode": "AU",
"postalCode": "2138",
"administrativeArea": "NSW",
"locality": "Concord West",
"addressLines": [
"Killoola St",
"1"
]
}
}
}
},
"totalPrice": {
"type": "ESTIMATE",
"amount": {
"currencyCode": "AUD",
"units": "43",
"nanos": 100000000
}
},
"extension": {
"@type": "type.googleapis.com/google.actions.v2.orders.FoodOrderExtension",
"availableFulfillmentOptions": [
{
"fulfillmentInfo": {
"delivery": {
"deliveryTimeIso8601": "P0M"
}
}
}
]
},
"otherItems": [
{
"name": "Delivery fee",
"price": {
"type": "ESTIMATE",
"amount": {
"currencyCode": "AUD",
"units": "3",
"nanos": 500000000
}
},
"type": "DELIVERY"
}
]
},
"paymentOptions": {
"googleProvidedOptions": {
"facilitationSpecification": "{\"apiVersion\":2,\"apiVersionMinor\":0,\"merchantInfo\":{\"merchantName\":\"merchantName\"},\"allowedPaymentMethods\":[{\"type\":\"CARD\",\"parameters\":{\"allowedAuthMethods\":[\"PAN_ONLY\"],\"allowedCardNetworks\":[\"VISA\",\"MASTERCARD\"],\"billingAddressRequired\":true,\"cvcRequired\":false},\"tokenizationSpecification\":{\"type\":\"PAYMENT_GATEWAY\",\"parameters\":{\"gatewayMerchantId\":\"YOUR_MERCHANT_ID\",\"gateway\":\"cybersource\"}}}],\"transactionInfo\":{\"currencyCode\":\"AUD\",\"totalPriceStatus\":\"ESTIMATED\",\"totalPrice\":\"43.1\"}} "
}
},
"additionalPaymentOptions": [
{
"actionProvidedOptions": {
"paymentType": "ON_FULFILLMENT",
"displayName": "Pay when you get your food.",
"onFulfillmentPaymentData": {
"supportedPaymentOptions": []
}
}
}
]
}
}
}
]
}
}
}
要求失敗
如果結帳要求失敗,CheckoutResponseMessage
必須包含 FoodErrorExtension
,其中包含說明發生的所有錯誤的 FoodOrderError
項目清單。如果訂單發生任何可復原的錯誤,例如購物車中商品的價格變更,FoodErrorExtension
必須包含 correctedProposedOrder
。
失敗回應範例
{
"expectUserResponse": false,
"finalResponse": {
"richResponse": {
"items": [
{
"structuredResponse": {
"error": {
"@type": "type.googleapis.com/google.actions.v2.orders.FoodErrorExtension",
"foodOrderErrors": [
{
"error": "CLOSED",
"description": "The restaurant is closed."
}
]
}
}
}
]
}
}
}