AddOffer

Represents an offer that the platform would like the POS integration to apply to a transaction as a part of an API response.

  • amount
    Type: string

    The amount of discount to apply.

  • auth
    Type: string

    An authorization code, as required by some POS systems to apply the discount. Usually in the case of a tender-based discount or stored-value card.

  • credential_identifier
    Type: string

    The credential that this offer belongs to.

  • name
    Type: string

    The name of the offer being applied. This can be shown on receipts or customer-facing check views.

  • pos_offer_code
    Type: string

    The POS-specific discount code to use. For instance, this may be the value of the unique ID of an open discount in the destination POS.

  • pos_offer_code_type
    Type: string

    The POS-specific discount type to use. Values are POS-specific.

  • qualifying_items
    Type: array object[] ยท QualifyingItem[]

    An array of qualifying items linked with the offer. The POS should use this field to apply the discount to specific items, and should send this information when including offers in requests.

    Represents an item that is discounted by or is required for a discount.

    • entry_id
      Type: string

      The unique entry_id of this item on the transaction.

    • line_number
      Type: string

      The line_number of this item on the transaction.

    • qualification_type
      enum

      An enum representing the type of qualification. "1" signifies the referenced item is being redeemed/discounted. "2" signifies that the referenced item is required for the discount, but is not itself being discounted.

      values
      • 1
      • 2
  • quantity
    Type: string

    The quantity of offers to apply.

  • sparkfly_auth_code
    Type: string

    The Sparkfly authorization code associated with the offer. This should be stored locally by the POS and sent in future requests referencing the offer.

  • tip
    Type: string

    The amount that should be applied as a tip, in addition to amount, in the case where the discount type allows for tips, such as with tenders.