Toast Yourendpointname API

openapi: 3.2.0
info:
  title: Toast Yourendpointname API
  version: '1.0'
  description: 'Operations tagged Yourendpointname across 3 of this provider''s published API definitions: toast-gift-cards-openapi.yaml, toast-loyalty-openapi.yaml, toast-tender-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://toast-api-server/yourapiname/v1
- url: /yourapiname/v1
tags:
- name: Yourendpointname
paths:
  /yourendpointname:
    post:
      operationId: yourendpointnamePost
      summary: 'Returns gift card transaction information

        '
      description: "Provides information about a gift card transaction processed by \nthe Toast platform. The transaction information in the \nmessage body is intended to allow a gift card provider to \nperform corresponding operations on the gift card account, \nmaintained by that provider.\n\nYou define the endpoint name for this implementation. The Toast \nplatform makes requests to the REST path that you supply \nduring integration setup.\n\nEach `POST` request to the endpoint includes a \n`Toast-Transaction-Type` header parameter value to indicate the \ntype of gift card transaction it represents. The possible \ntransaction types are:\n\n* Activate a new gift card.\n* Add value to an active gift card.\n* Get the current balance of a gift card.\n* Redeem value from a gift card, for example for a purchase.\n* Reverse a previous transaction, for example to void a purchase \n  made with the gift card.\n\nThe `GiftCardTransaction` \nobject in the message body includes a set of information that \nis specific for each transaction type.\n\nThe response time for a gift card transaction request must be \nless than 500ms.\n\nAll gift card transactions must be considered idempotent. The \nimplementation must handle multiple requests with the same \n`Toast-Transaction-GUID` *and* the same `giftCardIdentifier`.\n"
      parameters:
      - name: Toast-Transaction-GUID
        description: "A unique identifier of the gift card transaction, defined \nby the Toast platform.\n"
        in: header
        schema:
          type: string
      - name: Toast-Restaurant-External-ID
        description: "The unique identifier of the restaurant, defined by the \nToast platform.\n"
        in: header
        schema:
          type: string
      - name: Toast-Transaction-Type
        description: "The type of gift card transaction that occurred. Values are:\n<ul>\n  <li>GIFTCARD_ACTIVATE</li>\n  <li>GIFTCARD_ADD_VALUE</li>\n  <li>GIFTCARD_GET_BALANCE</li>\n  <li>GIFTCARD_REDEEM</li>\n  <li>GIFTCARD_REVERSE</li>\n</ul>\n"
        in: header
        schema:
          type: string
          enum:
          - GIFTCARD_ACTIVATE
          - GIFTCARD_ADD_VALUE
          - GIFTCARD_GET_BALANCE
          - GIFTCARD_REDEEM
          - GIFTCARD_REVERSE
      - name: Authorization
        description: a JSON Web Token (JWT) that you can use to authenticate the request. Verify the token using the public key that you get from the Toast user management service.
        in: header
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GiftCardTransaction'
        description: "A `GiftCardTransaction` \nobject containing information about the gift card \ntransaction that the Toast platform processed.\n"
      responses:
        '200':
          description: "OK. The `transactionStatus` value of the \n`GiftCardTransactionResponse` object is `ACCEPT`.\n"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GiftCardTransactionResponse'
        '400':
          description: "Bad request. The `transactionStatus` value of the \n`GiftCardTransactionResponse` object is one of: \n\n* `ERROR_INVALID_TOAST_TRANSACTION_TYPE`\n* `ERROR_CARD_ALREADY_ACTIVATED`\n* `ERROR_CARD_NOT_ACTIVATED`\n* `ERROR_CARD_INVALID`\n* `ERROR_INVALID_INPUT_PROPERTIES`\n* `ERROR_TRANSACTION_DOES_NOT_EXIST`\n* `ERROR_INVALID_TOKEN`\n* `ERROR_TRANSACTION_CANNOT_BE_REVERSED`\n* `ERROR_INVALID_RESTAURANT`\n* `ERROR_VERIFICATION_FAILED`\n* `ERROR_VERIFICATION_REQUIRED`\n* `ERROR_VERIFICATION_NOT_SUPPORTED`\n"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GiftCardTransactionResponse'
        '500':
          description: Internal server error.
      tags:
      - Yourendpointname
    servers:
    - url: https://toast-api-server/yourapiname/v1
components:
  schemas:
    TransactionResponseAddValue:
      type: object
      description: "Information about a gift card transaction from the gift card \nservice provider for add value transactions. The Toast platform \nuses this information to complete guests' gift card transactions.\n"
      properties:
        currentBalance:
          description: 'The currency amount of the funds available from the gift card.

            '
          type: number
          format: double
    TransactionResponseGetBalance:
      type: object
      description: "Information about a gift card transaction from the gift card \nservice provider for get balance transactions. The Toast POS \nsystem uses this information to complete guests' gift card \ntransactions.\n"
      properties:
        currentBalance:
          description: 'The currency amount of the funds available from the gift card.

            '
          type: number
          format: double
    TransactionInformationRedeem:
      allOf:
      - $ref: '#/components/schemas/TransactionInformation'
      - type: object
        description: "Information about a gift card transaction in the Toast  \nplatform that reduces the balance of funds available from the card. \nFor example, when the gift card is used for a purchase. Gift card \nproviders are expected to handle the transaction.\n"
        properties:
          redeemedValue:
            description: "The currency amount of the funds being redeemed from the gift \ncard.\n"
            type: number
            format: double
          checkIdentifier:
            description: 'The unique identifier of the check that this gift card transaction

              is part of. No action needs to be taken based on this identifier,

              it is just provided for tracking purposes.

              '
            type: string
          isCashOut:
            description: 'True if this redeem transaction is a cash out transaction,

              false otherwise

              '
            type: boolean
          relatedTransaction:
            description: 'The Toast platform unique identifier for a previous gift card transaction.

              Your integration can use this identifier to confirm information about a

              previous, related transaction such as PIN verification. For example, if a

              restaurant employee adds a tip or gratuity to a transaction, the Toast POS

              reverses the initial redemption and sends another redemption with the new

              amount. This value provides the identifier of the initial transaction. If the

              current transaction is not part of an adjustment (for example, reversing a

              transaction) this value is `null`.

              '
            type: string
    TransactionInformationAddValue:
      allOf:
      - $ref: '#/components/schemas/TransactionInformation'
      - type: object
        description: "Information about a gift card transaction in the Toast POS \nsystem that adds to the funds that are available on the card. \nGift card providers are expected to handle the transaction.\n"
        properties:
          additionalValue:
            description: 'The currency amount of the funds being added to the gift card.

              '
            type: number
            format: double
          checkIdentifier:
            description: 'The unique identifier of the check that this gift card transaction

              is part of. No action needs to be taken based on this identifier,

              it is just provided for tracking purposes.

              '
            type: string
    TransactionResponseReverse:
      type: object
      description: "Information about a gift card transaction from the gift card \nservice provider that undoes a previous gift card transaction. \nThe Toast platform uses this information to complete guests' \ngift card transactions.\n"
      properties:
        currentBalance:
          description: 'The currency amount of the funds available from the gift card.

            '
          type: number
          format: double
    TransactionInformationActivate:
      allOf:
      - $ref: '#/components/schemas/TransactionInformation'
      - type: object
        description: "Information about a gift card transaction in the Toast  \nplatform that activates a new card. Gift card providers are \nexpected to handle the transaction.\n"
        properties:
          initialBalance:
            description: 'The currency amount of the funds available from the gift card.

              '
            type: number
            format: double
          checkIdentifier:
            description: 'The unique identifier of the check that this gift card transaction

              is part of. No action needs to be taken based on this identifier,

              it is just provided for tracking purposes.

              '
            type: string
    TransactionInformation:
      type: object
      properties:
        giftCardIdentifier:
          description: 'The unique identifier of the gift card.

            '
          type: string
        identifierSource:
          description: 'Indicates how the Toast platform received the gift card identifier string. Values are:


            * `KEYED` - A restaurant employee or guest manually entered the identifier string.


            * `SCANNED` - A restaurant employee or guest used a barcode scanner or other scanning device to enter the identifier string.


            * `SWIPED` - A restaurant employee or guest used a magnetic card strip reader to enter the identifier string.


            * `KEYED_ONLINE` - The source of this transaction is Toast Online Ordering, The provider can reject the transaction regardless of the restaurant''s verification code settings.


            * `UNKNOWN` - The Toast platform received the identifier string using a method other than `KEYED`, `SCANNED`, or `SWIPED`, or the method is not known.

            '
          type: string
          enum:
          - KEYED
          - SCANNED
          - SWIPED
          - KEYED_ONLINE
          - UNKNOWN
        verificationCode:
          type: object
          description: 'The verification code, also often referred to as a PIN code, for the gift card account. A verification code is an additional layer of security that some gift card providers include.

            '
          properties:
            value:
              description: 'The verification code value of the gift card.

                '
              type: string
            source:
              description: "Indicates how the Toast platform received the verification code value. This can differ from an `identifierSource` if the verification code is keyed in by a restaurant employee or guest after a swipe.\n\nValues are:\n\n* `KEYED` - A restaurant employee or guest manually entered the verification code string.\n\n* `SCANNED` - A restaurant employee or guest used a barcode scanner or other scanning device to enter the verification code string.\n\n* `SWIPED` - A restaurant employee or guest used a magnetic card strip reader to enter the verification code string. \n\n* `VERIFIED` - The Toast platform has previously verified the verification code for this transaction. This is commonly used in the subsequent transactions on the same order. The provider should ignore the validation.\n\n* `UNKNOWN` - The Toast platform received the verification code string using a method other than `KEYED`, `SCANNED`, or `SWIPED`, or the method is not known.\n"
              type: string
              enum:
              - KEYED
              - SCANNED
              - SWIPED
              - VERIFIED
              - UNKNOWN
    TransactionInformationReverse:
      type: object
      description: "Information about a gift card transaction in the Toast  \nplatform that undoes a previous transaction. Gift card providers \nare expected to handle the transaction. The only types of\ntransactions that can be reversed are `GIFTCARD_ADD_VALUE`,\n`GIFTCARD_REDEEM`, and `GIFTCARD_ACTIVATE`.\nIf a `GIFTCARD_ADD_VALUE` is reversed then the amount of the\noriginal transaction should be deducted from the card's balance.\nIf a `GIFTCARD_REDEEM` is reversed then the amount of the\noriginal transaction should be added to the card's balance.\nIf a `GIFTCARD_ACTIVATE` is reversed then the card should be\nset to inactive and its balance set to `0.00`.\n`GIFTCARD_GET_BALANCE` and `GIFTCARD_REVERSE` cannot be reversed.\n"
      allOf:
      - $ref: '#/components/schemas/TransactionInformation'
      properties:
        previousTransaction:
          description: "The identifier of an earlier gift card transaction. This \nidentifier is provided in the `Toast-Transaction-GUID` header \nparameter.\n"
          type: string
          format: guid
    GiftCardTransaction:
      type: object
      description: "Information about a gift card transaction in the Toast  \nplatform. Gift card providers are expected to handle that \ntransaction.\n\nThe set of information in this object depends on the gift card \ntransaction type. The transaction type is specified in the \n`Toast-Transaction-Type` header parameter for the request.\n\nThe `GiftCardTransaction` object includes the following values \nfor specific transaction types:\n\n* `GIFTCARD_ACTIVATE` - includes an `activateTransactionInformation` value.\n* `GIFTCARD_ADD_VALUE` - includes an `addValueTransactionInformation` value.\n* `GIFTCARD_GET_BALANCE` - includes a `getBalanceTransactionInformation` value.\n* `GIFTCARD_REDEEM` - includes a `redeemTransactionInformation` value.\n* `GIFTCARD_REVERSE` - includes a `reverseTransactionInformation` value.\n"
      properties:
        activateTransactionInformation:
          $ref: '#/components/schemas/TransactionInformationActivate'
        addValueTransactionInformation:
          $ref: '#/components/schemas/TransactionInformationAddValue'
        getBalanceTransactionInformation:
          $ref: '#/components/schemas/TransactionInformationGetBalance'
        redeemTransactionInformation:
          $ref: '#/components/schemas/TransactionInformationRedeem'
        reverseTransactionInformation:
          $ref: '#/components/schemas/TransactionInformationReverse'
    TransactionResponseActivate:
      type: object
      description: "Information about a gift card transaction from the gift card \nservice provider for activating a new gift card. The Toast POS \nsystem uses this information to complete guests' gift card \ntransactions.\n"
      properties:
        currentBalance:
          description: 'The currency amount of the funds available from the gift card.

            '
          type: number
          format: double
    GiftCardTransactionResponse:
      type: object
      description: "Information about a gift card transaction from the gift \ncard provider. The Toast platform uses this information to \ncomplete guests' gift card transactions.\n\nThe set of information in this object depends on the gift card \ntransaction type. The transaction type is specified in the \n`Toast-Transaction-Type` header parameter for the request.\n\nAll `GiftCardTransactionResponse` objects must include a \n`transactionStatus` value.\n\nThe `GiftCardTransactionResponse` object includes the following \nadditional values for specific transaction types:\n\n* `GIFTCARD_ACTIVATE` - includes an `activateResponse` value.\n* `GIFTCARD_ADD_VALUE` - includes an `addValueResponse` value.\n* `GIFTCARD_GET_BALANCE` - includes a `getBalanceResponse` value.\n* `GIFTCARD_REDEEM` - includes a `redeemResponse` value.\n* `GIFTCARD_REVERSE` - includes a `reverseResponse` value.\n\nFor \nexample, the response object for a `GIFTCARD_ACTIVATE` transaction \nincludes an `activateResponse` value.\n"
      properties:
        transactionStatus:
          description: "Indicates the result of a gift card transaction, reported by the\ngift card service provider. Possible values are:\n\n<ul>\n  <li>`ACCEPT` - The gift card service provider processed the transaction successfully.</li>\n  <li>`ERROR_INVALID_TOAST_TRANSACTION_TYPE` - The requested Toast-Transaction-Type is not valid.</li>\n  <li>`ERROR_CARD_ALREADY_ACTIVATED` - The gift card has already been activated.</li>\n  <li>`ERROR_CARD_NOT_ACTIVATED` - The gift card has not been activated.</li>\n  <li>`ERROR_CARD_INVALID` - The gift card is not valid at the current restaurant.</li>\n  <li>`ERROR_INVALID_INPUT_PROPERTIES` - The specified JSON properties in the request body are not valid.</li>\n  <li>`ERROR_TRANSACTION_DOES_NOT_EXIST` - The transaction that is being requested to be reversed does not exist.\n    Only occurs on a `GIFTCARD_REVERSE`</li>\n  <li>`ERROR_INVALID_TOKEN` - The token supplied in the `Authorization` header field is invalid or cannot be validated.</li>\n  <li>`ERROR_TRANSACTION_CANNOT_BE_REVERSED` - The specified transaction cannot be reversed. `GIFTCARD_GET_BALANCE`\n    and `GIFTCARD_REVERSE` transactions cannot be reversed.</li>\n  <li>`ERROR_INVALID_RESTAURANT` - The restaurant specified by the `Toast-Restaurant-External-ID` is invalid.</li>\n  <li>`ERROR_VERIFICATION_FAILED` - Verification data specified by the JSON body is invalid.</li>\n  <li>`ERROR_VERIFICATION_REQUIRED` - Verification data necessary to complete the transaction but the data is missing or `null` in the JSON body.</li>\n  <li>`ERROR_VERIFICATION_NOT_SUPPORTED` - Verification data is provided by the JSON body but the provider doesn't support verification.</li>\n</ul>\n"
          type: string
          enum:
          - ACCEPT
          - ERROR_INVALID_TOAST_TRANSACTION_TYPE
          - ERROR_CARD_ALREADY_ACTIVATED
          - ERROR_CARD_NOT_ACTIVATED
          - ERROR_CARD_INVALID
          - ERROR_INVALID_INPUT_PROPERTIES
          - ERROR_TRANSACTION_DOES_NOT_EXIST
          - ERROR_INVALID_TOKEN
          - ERROR_TRANSACTION_CANNOT_BE_REVERSED
          - ERROR_INVALID_RESTAURANT
          - ERROR_VERIFICATION_FAILED
          - ERROR_VERIFICATION_REQUIRED
          - ERROR_VERIFICATION_NOT_SUPPORTED
        activateResponse:
          $ref: '#/components/schemas/TransactionResponseActivate'
        addValueResponse:
          $ref: '#/components/schemas/TransactionResponseAddValue'
        getBalanceResponse:
          $ref: '#/components/schemas/TransactionResponseGetBalance'
        redeemResponse:
          $ref: '#/components/schemas/TransactionResponseRedeem'
        reverseResponse:
          $ref: '#/components/schemas/TransactionResponseReverse'
    TransactionResponseRedeem:
      type: object
      description: "Information about a gift card transaction from the gift card \nservice provider that reduces the balance of funds available from \nthe card. For example, when the gift card is used for a purchase. \nThe Toast platform uses this information to complete guests' \ngift card transactions.\n"
      properties:
        currentBalance:
          description: 'The currency amount of the funds available from the gift card.

            '
          type: number
          format: double
        redeemedValue:
          type: number
          format: double
          description: "The currency amount of the funds that were redeemed from the \ngift card. This value may be different than the \n`redeemedValue` in a gift card transaction request. For \nexample, if the card balance is less than the redeem value \nrequested by the Toast platform, the `redeemedValue` in the \nresponse will be less than the `redeemedValue in the request.\n"
    TransactionInformationGetBalance:
      type: object
      description: "Information about a gift card transaction in the Toast  \nplatform that requests the currency value of the funds available \nfrom the gift card. Gift card providers are expected to handle \nthe transaction.\n"
      allOf:
      - $ref: '#/components/schemas/TransactionInformation'
    Device:
      type: object
      description: The *Device ID* value that the Toast POS system assigns to a specific Toast POS device. The `id` value is a unique identifier for a device. To find the ID for a Toast POS device, do the following. From the overflow  menu (⋮) select *Device Status* and then select the *Device* tab.
      properties:
        id:
          type: string
          description: The physical id of the device
    TransactionInformationCheck:
      type: object
      description: "Information needed to complete an inquire, redeem, or accrue transaction. Included if the \ntoastTransactionType is one of LOYALTY_INQUIRE, LOYALTY_REDEEM, or LOYALTY_ACCRUE,\nabsent otherwise.\n"
      properties:
        loyaltyIdentifier:
          description: Unique identifier of the loyalty account. Format will vary by provider.
          type: string
        orderGuid:
          description: The Toast POS system identifier for the order that contains the check.
          type: string
        check:
          $ref: '#/components/schemas/Check'
        redemptions:
          description: 'List of offers to be redeemed, or already redeemed on a check. If this is the

            first time this particular Redemption has been present in a request (as part of

            this customer interaction), it will be present in this list but not on the Check.

            If a Redemption has been previously validated, it will be present both in this list

            and on the Check as an `AppliedDiscount`.

            '
          type: array
          items:
            $ref: '#/components/schemas/Redemption'
    AppliedDiscountTrigger:
      type: object
      description: The Selection which triggered the application of this discount
      properties:
        selection:
          $ref: '#/components/schemas/ExternalReference'
        quantity:
          type: number
          format: double
          description: The amount of the selection used to trigger the applied discount.
    ItemRedemptionInfo:
      type: object
      description: Information about the application of a `Redemption` to a specific item.
      properties:
        selectionIdentifier:
          description: 'The identifier of the selection that discount is applied to. This will correspond to the `guid`

            field on the `Selection` object that is included with the `Check`. Toast uses these values to determine

            which item(s) will have the offer applied.

            '
          type: string
        amount:
          description: 'The currency amount of the discount applied to this item. This value can be updated in future calls.

            This field is optional in response to LOYALTY_INQUIRE requests and required in response to LOYALTY_REDEEM requests.

            '
          type: number
        appliedDiscountIdentifier:
          description: 'If this redemption has been applied, this is the identifier of the applied discount created for this offer

            on this selection. It will correspond to the `guid` field of the `AppliedDiscount` object on the Selection.

            Response only.

            '
    TransactionInformationReverse_2:
      type: object
      description: 'Information needed to complete a reverse transaction. Included if the toastTransactionType is

        LOYALTY_REVERSE, absent otherwise.

        '
      properties:
        loyaltyIdentifier:
          description: Unique identifier of the loyalty account. Format will vary by provider.
          type: string
        transactionId:
          description: Id of a previous transaction to reverse.
          type: string
        redemptions:
          description: If the transaction to be reversed was a LOYALTY_REDEEM transaction, this array optional includes the list of redemptions from that transaction to reverse. If this field is absent, all redemptions from the transaction should be reversed.
          type: array
          items:
            $ref: '#/components/schemas/Redemption'
    LoyaltyTransaction:
      type: object
      description: "Information about a loyalty transaction in the Toast POS \nsystem. Loyalty providers are expected to handle that \ntransaction.\n\nThe set of information in this object depends on the loyalty \ntransaction type. The transaction type is specified in the \n`Toast-Transaction-Type` header parameter for the request, \nand within the body of the request.\n\nThe `LoyaltyTransaction` object includes the `toastTransactionType`\nvalue, which will be the same as the value in the header. It will also\ninclude one of the following values depending on the transaction type:\n\n* `LOYALTY_INQUIRE` - checkTransactionInformation\n* `LOYALTY_SEARCH` - searchTransactionInformation\n* `LOYALTY_SIGNUP` - signupTransactionInformation\n* `LOYALTY_REDEEM` - checkTransactionInformation\n* `LOYALTY_ACCRUE` - checkTransactionInformation\n* `LOYALTY_REVERSE` - reverseTransactionInformation\n* `LOYALTY_TRANSFER` - transferTransactionInformation\n"
      properties:
        toastTransactionType:
          description: 'The transaction type that is included in the header is duplicated here in the body of the request.

            '
          type: string
          enum:
          - LOYALTY_INQUIRE
          - LOYALTY_SEARCH
          - LOYALTY_SIGNUP
          - LOYALTY_REDEEM
          - LOYALTY_ACCRUE
          - LOYALTY_REVERSE
          - LOYALTY_TRANSFER
        searchTransactionInformation:
          $ref: '#/components/schemas/TransactionInformationSearch'
        signupTransactionInformation:
          $ref: '#/components/schemas/TransactionInformationSignup'
        checkTransactionInformation:
          $ref: '#/components/schemas/TransactionInformationCheck'
        reverseTransactionInformation:
          $ref: '#/components/schemas/TransactionInformationReverse_2'
        transferTransactionInformation:
          $ref: '#/components/schemas/TransactionInformationTransfer'
    ToastReference:
      type: object
      description: A wrapper object with fields that allow reference to a Toast entity by Toast GUID.
      required:
      - guid
      - entityType
      properties:
        guid:
          description: The GUID maintained by Toast.
          type: string
        entityType:
          description: The type of object this is.
          type: string
    AppliedLoyaltyInfo:
      type: object
      description: Information about the customer loyalty program account associated with a check.
      required:
      - loyaltyIdentifier
      - vendor
      allOf:
      - $ref: '#/components/schemas/ToastReference'
      - type: object
        properties:
          loyaltyIdentifier:
            type: string
            description: An identifier for the loyalty program account.
          vendor:
            type: string
            description: The specific loyalty program service provider that supports the loyalty account. For all interactions with the Loyalty Integration API, this value will be INTEGRATION.
            enum:
            - INTEGRATION
          accrualFamilyGuid:
            type: string
            description: An internal Toast POS identifier for loyalty program transactions.
          accrualText:
            type: string
            description: A description of the loyalty program transaction that will be printed on the customer's reciept. For example, "Earned 27 points." The maximum length of the description string is 255 characters.
    TransactionInformationSearch:
      type: object
      description: 'Information needed to complete a search transaction. Included if the toastTransactionType is

        LOYALTY_SEARCH, absent otherwise.

        '
      properties:
        searchCriteria:
          $ref: '#/components/schemas/AccountSearchCriteria'
    Offer:
      type: object
      description: "Information about a potential discount or other benefit available to the holder of \na loyalty account. Contrast with a `Redemption`,\nwhich is an Offer that is applied to a `Check`.\n"
      properties:
        identifier:
          description: 'A unique identifier for this offer. Each offer must have a unique

            identifier. The Toast platform will not apply discounts correctly if

            your integration uses an identifier for more than one offer on a

            check.

            '
          type: string
        name:
          description: 'The name of this discount. This should be a human readable description of the order.

            Examples include "5% off your entire order" or "Free small cheese pizza".

            '
          type: string
        applicable:
          description: 'true if this offer can be applied to the check submitted with the request,

            false otherwise

            '
          type: boolean
        selectionType:
          description: "Describes what this offer covers. A `CHECK` level discount applies to the entire\ncheck, without requirements on the items contained within the check. An `ITEM` \nlevel discount applies to a specific item on the check. \n"
          type: string
          enum:
          - CHECK
          - ITEM
          - MULTI_ITEM
        itemApplication:
          type: array
          description: 'If this offer is of type ITEM or MULTI_ITEM, this array includes the selection or selections

            to which the offer can be applied. Required if applicable is true, optional otherwise.

            '
          items:
            $ref: '#/components/schemas/ItemRedemptionInfo'
        amount:
          description: 'The currency amount of the discount when applied based on the current check information.

            This value can be updated in future calls based on updated check information (for example,

            a 10% off offer will change based on the check total). This field is optional in response to

            LOYALTY_INQUIRE requests and required in response to LOYALTY_REDEEM requests. If the selection type

            is ITEM or MULTI_ITEM, this amount should be the sum of the amounts on each ItemRedemptionInfo in

            the itemApplication array.

            '
          type: number
        quantity:
          description: 'The quantity of this reward available to the account owner. This is informational to display to the

            user. It does not necessarily mean the offer is redeemable multiple times (for example, a guest may

            have two "10% off your entire check" offers, but only one can be redeemed per visit).

            '
          type: number
        expiration:
          type: array
          description: If this offer will expire, expiration dates can be included in this element to indicate on which date(s) this offer will expire. The next upcoming expiration date will be displayed for the offer on the POS. Optional.
          items:
            $ref: '#/components/schemas/ExpirationData'
        description:
          type: string
          description: 'Optional description providing additional context about the offer, such as requirements

            or restrictions. This text will be displayed on the Customer''s Reward Screen to help guests

            understand offer eligibility before attempting redemption. Examples include "Requires additional

            purchase of $0.50" or "Valid on dine-in orders only". Maximum 200 characters. Optional.

            '
        autoApply:
          description: 'Indicates whether the offer should be automatically applied to the check without requiring explicit

            action from a guest or employee. When `true`, the Toast platform will automatically apply the offer.

            If you do not provide an `autoApply` value, the Toast platform uses the default value `false`. This

            Toast platform feature is in limited release. Not all Toast POS locations will automatically apply

            offers in response to this value.

            '
          type: boolean
          default: false
    LoyaltyTransactionResponse:
      type: object
      description: "Information about a loyalty transaction from the loyalty provider. The Toast POS system\nuses this information to complete guests' loyalty transactions.\n\nThe se

# --- truncated at 32 KB (124 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/toast/refs/heads/main/openapi/toast-yourendpointname-api-openapi.yml