ItemIntegrationAttributes

Metadata associated with an item used for downstream integrations.

JSON representation
{
  "customIntegrationAttributes": {
    object
  },
  "streamAttributes": {
    object (StreamIntegrationAttributes)
  },
  "toastAttributes": {
    object (ToastIntegrationAttributes)
  }
}
Fields
customIntegrationAttributes

object (Struct format)

Optional. Arbitrary metadata to be associated with an entity, used to build downstream integrations, i.e. identifiers or schema information for constructing an order for submission to a third-party point of sale API.

streamAttributes

object (StreamIntegrationAttributes)

Optional. Represents metadata associated with this item used for Stream integration. If Stream integration isn't enabled for the store, this field is ignored.

toastAttributes

object (ToastIntegrationAttributes)

Optional. Represents metadata associated with this item used for Toast integration. If Toast integration isn't enabled for the store, this field is ignored.

StreamIntegrationAttributes

Represents attributes for an Item from a Stream menu.

JSON representation
{
  "taxes": [
    {
      object (Tax)
    }
  ],
  "itemFamilyId": string
}
Fields
taxes[]

object (Tax)

Optional. Represents tax rates which apply to this item.

itemFamilyId

string

Optional. Represents the item family that contains this item variant in Stream's menu.

Tax

Tax rate information associated with this item.

JSON representation
{
  "streamId": string,
  "isInclusive": boolean,
  "rate": number,
  "displayName": string,
  "isDefault": boolean
}
Fields
streamId

string

Required. The ID of the tax in the Stream menu.

isInclusive

boolean

Optional. Determines if the tax amount is already included in the item price

rate

number

Required. The rate of the tax as a percentage.

displayName

string

Optional. The name of the tax.

isDefault

boolean

Optional. Whether the tax is the default tax.

ToastIntegrationAttributes

Represents attributes for an Item from a Toast menu.

JSON representation
{
  "menuGroupGuid": string
}
Fields
menuGroupGuid

string

Optional. Represents the menu group guid of the item in Toast's menu.