Transactions API will be deprecated on May 3, 2023, ahead of the Conversational Actions sunset on June 13, 2023. For more information, see Conversational Actions sunset.
OrderOptions
Stay organized with collections
Save and categorize content based on your preferences.
AI-generated Key Takeaways
OrderOptions define options associated with an order, including whether a delivery address is required and user information options.
The requestDeliveryAddress field is a boolean that, if true, signifies a delivery address is necessary for the order.
userInfoOptions is an object that, if set, allows the app to request specific user information properties, which will be displayed for user confirmation.
UserInfoOptions contains a list of user info properties defined by the userInfoProperties enum.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[],["The document defines order options using JSON. It allows specifying whether a delivery address is required (`requestDeliveryAddress`), represented by a boolean. It also defines `userInfoOptions`, an object enabling apps to request user information. `userInfoOptions` uses `userInfoProperties`, an array of enumerated user info properties, for the specific details to be requested. If set, these fields appear in the ProposedOrderCard for user confirmation. The provided data structure and its types are detailed in associated tables.\n"]]