# ProposedOrder

- [JSON representation](https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/ProposedOrder#SCHEMA_REPRESENTATION)
- [Cart](https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/ProposedOrder#Cart)
  - [JSON representation](https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/ProposedOrder#Cart.SCHEMA_REPRESENTATION)
- [Merchant](https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/ProposedOrder#Merchant)
  - [JSON representation](https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/ProposedOrder#Merchant.SCHEMA_REPRESENTATION)
- [LineItem](https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/ProposedOrder#LineItem)
  - [JSON representation](https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/ProposedOrder#LineItem.SCHEMA_REPRESENTATION)
- [SubLine](https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/ProposedOrder#SubLine)
  - [JSON representation](https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/ProposedOrder#SubLine.SCHEMA_REPRESENTATION)
- [Promotion](https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/ProposedOrder#Promotion)
  - [JSON representation](https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/ProposedOrder#Promotion.SCHEMA_REPRESENTATION)

> [!WARNING]
> This item is deprecated!

Deprecated: Use V3 Proto instead. Order that the caller is requesting the user to confirm.

| JSON representation ||
|---|---|
| ``` { "id": string, "cart": { object (`https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/ProposedOrder#Cart`) }, "otherItems": [ { object (`https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/ProposedOrder#LineItem`) } ], "image": { object (`https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/Image`) }, "termsOfServiceUrl": string, "totalPrice": { object (`https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/Price`) }, "extension": { "@type": string, field1: ..., ... } } ``` |

| Fields ||
|---|---|
| `id` | `string` Optional id for this ProposedOrder. Included as part of the ProposedOrder returned back to the integrator at confirmation time. |
| `cart` | ``object (`https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/ProposedOrder#Cart`)`` User's items. |
| `otherItems[]` | ``object (`https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/ProposedOrder#LineItem`)`` Fees, adjustments, subtotals, etc. |
| `image` | ``object (`https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/Image`)`` Image associated with the proposed order. |
| `termsOfServiceUrl` | `string` A link to the terms of service that apply to this proposed order. |
| `totalPrice` | ``object (`https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/Price`)`` Total price of the proposed order. If of type `ACTUAL`, this is the amount the caller will charge when the user confirms the proposed order. |
| `extension` | `object` 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 `https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/GenericExtension#OrderLocation` value. An object containing fields of an arbitrary type. An additional field `"@type"` contains a URI identifying the type. Example: `{ "id": 1234, "@type": "types.example.com/standard/id" }`. |

## Cart

> [!WARNING]
> This item is deprecated!

Deprecated: Use V3 Proto instead. Cart of items the user wants.

| JSON representation ||
|---|---|
| ``` { "id": string, "merchant": { object (`https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/ProposedOrder#Merchant`) }, "lineItems": [ { object (`https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/ProposedOrder#LineItem`) } ], "otherItems": [ { object (`https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/ProposedOrder#LineItem`) } ], "notes": string, "promotions": [ { object (`https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/ProposedOrder#Promotion`) } ], "extension": { "@type": string, field1: ..., ... } } ``` |

| Fields ||
|---|---|
| `id` | `string` Optional id for this cart. Included as part of the Cart returned back to the integrator at confirmation time. |
| `merchant` | ``object (`https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/ProposedOrder#Merchant`)`` Merchant for the cart, if different from the caller. |
| `lineItems[]` | ``object (`https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/ProposedOrder#LineItem`)`` The good(s) or service(s) the user is ordering. There must be at least one line item. |
| `otherItems[]` | ``object (`https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/ProposedOrder#LineItem`)`` Adjustments entered by the user, e.g. gratuity. |
| `notes` | `string` Notes about this cart. |
| `promotions[]` | ``object (`https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/ProposedOrder#Promotion`)`` Optional. Promotional coupons added to the cart. Eligible promotions will be sent back as discount line items in proposed order. |
| `extension` | `object` Extension to the cart based on the type of order. An object containing fields of an arbitrary type. An additional field `"@type"` contains a URI identifying the type. Example: `{ "id": 1234, "@type": "types.example.com/standard/id" }`. |

## Merchant

> [!WARNING]
> This item is deprecated!

Deprecated: Use V3 Proto instead. Merchant for the cart.

| JSON representation ||
|---|---|
| ``` { "id": string, "name": string } ``` |

| Fields ||
|---|---|
| `id` | `string` Id of the merchant. |
| `name` | `string` User-visible name of the merchant. Required. |

## LineItem

> [!WARNING]
> This item is deprecated!

Deprecated: Use V3 Proto instead. Line item in order.

| JSON representation ||
|---|---|
| ``` { "id": string, "name": string, "type": enum (`https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/LineItemType`), "quantity": integer, "description": string, "image": { object (`https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/Image`) }, "price": { object (`https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/Price`) }, "subLines": [ { object (`https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/ProposedOrder#SubLine`) } ], "offerId": string, "extension": { "@type": string, field1: ..., ... } } ``` |

| Fields ||
|---|---|
| `id` | `string` Unique id of the line item within the Cart/Order. Required. |
| `name` | `string` name of the line item as displayed in the receipt. Required. |
| `type` | ``enum (`https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/LineItemType`)`` type of line item. |
| `quantity` | `integer` Number of items included. |
| `description` | `string` description of the item. |
| `image` | ``object (`https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/Image`)`` Small image associated with this item. |
| `price` | ``object (`https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/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[]` | ``object (`https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/ProposedOrder#SubLine`)`` Sub-line item(s). Only valid if type is `REGULAR`. |
| `offerId` | `string` Optional product or offer id for this item. |
| `extension` | `object` Extension to the line item based on its type. An object containing fields of an arbitrary type. An additional field `"@type"` contains a URI identifying the type. Example: `{ "id": 1234, "@type": "types.example.com/standard/id" }`. |

## SubLine

SubLine item associated with line item in order.

| JSON representation ||
|---|---|
| ``` { // Union field `subline` can be only one of the following: "lineItem": { object (`https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/ProposedOrder#LineItem`) }, "note": string // End of list of possible types for union field `subline`. } ``` |

| Fields ||
|---|---|---|
| Union field `subline`. SubLine item. `subline` can be only one of the following: |||
| `lineItem` | ``object (`https://developers.google.com/assistant/df-asdk/reference/webhook/rest/Shared.Types/ProposedOrder#LineItem`)`` A generic line item (e.g. add-on). |
| `note` | `string` A note associated with the line item. |

## Promotion

> [!WARNING]
> This item is deprecated!

Deprecated: Use V3 Proto instead. Promotion added to cart.

| JSON representation ||
|---|---|
| ``` { "coupon": string } ``` |

| Fields ||
|---|---|
| `coupon` | `string` Required. Coupon code understood by 3P. For ex: GOOGLE10. |