TransactionItem

Represents a transaction line item on a transaction.

  • amount
    Type: string
    required

    The extended amount for this line item. This should be the total value of the line (i.e. quantity * base price).

  • entry_id
    Type: string
    required

    The POS-specific unique ID for this line item. This should be the ID of the line itself, not the ID of the menu item associated with the line

  • item_code
    Type: string
    required

    The POS-specific menu item ID for this line. This is the ID used to determine offer eligibility.

  • level
    Type: string
    required

    The hierarchy level for this line item, with 0 being the top level.

  • line_number
    Type: string
    required

    The line number, either provided by the POS or generated based on the order of the item as ordered by the POS

  • mode
    Type: string
    required

    Allows passing the "order state" of an item to Sparkfly. This is POS-specific and can be ignored if the situation doesn't have the concept. This is most useful in sending whether or not a line item has been sent to the kitchen and to consider it for item eligibility.

  • quantity
    Type: string
    required

    The quantity associated with this line item.

  • type
    Type: string
    required

    Allows passing a POS-specific "type" which may indicate the type of line item this is (such as "combo item", "modifier", etc.) This is POS-specific and all values are accepted.

  • categories
    Type: array string[]

    An array of strings, with each entry being a representation of the menu categories this line item's menu item belongs to.

  • description
    Type: string

    The longer name, as shown on the check in the POS, of this line. May be the longer, less abbreviated name.

  • linked_entry_id
    Type: string

    The POS-specific unique ID of the parent line to this line. For example, in the case of linking a combo sub-item to its parent, or a modifier to its parent.

  • linked_line_number
    Type: string

    Same linkage as linked_entry_id, but using the line_number field

  • name
    Type: string

    The name, as shown on the check in the POS, of this line. May be the short, kitchen display name.

  • seat
    Type: string

    The seat the line item is associated with. Typically only used in table service restaurants, and only if the POS provides it. The list under required contains the fields that must be provided.