Order that the caller is requesting the user to confirm.
JSON representation | |
---|---|
{ "id": string, "cart": { object( |
Fields | |
---|---|
id |
Optional id for this ProposedOrder. Included as part of the ProposedOrder returned back to the integrator at confirmation time. |
cart |
User's items. |
otherItems[] |
Fees, adjustments, subtotals, etc. |
image |
Image associated with the proposed order. |
termsOfServiceUrl |
A link to the terms of service that apply to this proposed order. |
totalPrice |
Total price of the proposed order. If of type |
extension |
Extension to the proposed order based on the kind of order. For example, if the order includes a location then this extension will contain a An object containing fields of an arbitrary type. An additional field |
Cart
Cart of items the user wants.
JSON representation | |
---|---|
{ "id": string, "merchant": { object( |
Fields | |
---|---|
id |
Optional id for this cart. Included as part of the Cart returned back to the integrator at confirmation time. |
merchant |
Merchant for the cart, if different from the caller. |
lineItems[] |
The good(s) or service(s) the user is ordering. There must be at least one line item. |
otherItems[] |
Adjustments entered by the user, e.g. gratuity. |
notes |
Notes about this cart. |
promotions[] |
Optional. Promotional coupons added to the cart. Eligible promotions will be sent back as discount line items in proposed order. |
extension |
Extension to the cart based on the type of order. An object containing fields of an arbitrary type. An additional field |
Merchant
Merchant for the cart.
JSON representation | |
---|---|
{ "id": string, "name": string } |
Fields | |
---|---|
id |
Id of the merchant. |
name |
User-visible name of the merchant. Required. |
LineItem
Line item in order.
JSON representation | |
---|---|
{ "id": string, "name": string, "type": enum( |
Fields | |
---|---|
id |
Unique id of the line item within the Cart/Order. Required. |
name |
Name of the line item as displayed in the receipt. Required. |
type |
Type of line item. |
quantity |
Number of items included. |
description |
Description of the item. |
image |
Small image associated with this item. |
price |
Each line item should have a price, even if the price is 0. Required. This is the total price as displayed on the receipt for this line (i.e. unit price * quantity). |
subLines[] |
Sub-line item(s). Only valid if type is |
offerId |
Optional product or offer id for this item. |
extension |
Extension to the line item based on its type. An object containing fields of an arbitrary type. An additional field |
SubLine
SubLine item associated with line item in order.
JSON representation | |
---|---|
{ // Union field |
Fields | ||
---|---|---|
Union field subline . SubLine item. subline can be only one of the following: |
||
lineItem |
A generic line item (e.g. add-on). |
|
note |
A note associated with the line item. |
Promotion
Promotion added to cart.
JSON representation | |
---|---|
{ "coupon": string } |
Fields | |
---|---|
coupon |
Required. Coupon code understood by 3P. For ex: GOOGLE10. |