LineItemUpdate

  • This document describes LineItemUpdate, a type within the deprecated Orders version 2 API for updating individual line items.

  • LineItemUpdate requires at least one of orderState or price to be specified.

  • The LineItemUpdate object can include fields for orderState, price, reason, and extension.

  • The reason field is required when changing the price of a line item.

Updates for individual line items. At least one of orderState or price should be specified.

JSON representation 
{
  "orderState": {
    object(OrderState)
  },
  "price": {
    object(Price)
  },
  "reason": string,
  "extension": {
    "@type": string,
    field1: ...,
    ...
  }
}
Fields
orderState

object(OrderState)

New line item-level state.

price

object(Price)

New price for the line item.

reason

string

Reason for the change. Required for price changes.

extension

object

Update to the line item extension. Type must match the item's existing extension 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" }.