Login
      Contents x
      /v23.1/LoyaltyCards
      • 05 Jun 2024
      • 1 Minute to read
      • Contributors
      • Print
      • Dark
        Light
      • PDF
      Contents

      /v23.1/LoyaltyCards

      • Updated on 05 Jun 2024
      • 1 Minute to read
      • Contributors
      • Print
      • Dark
        Light
      • PDF
      Article summary

      Get
      /v23.1/LoyaltyCards
      Security
      HTTP
      Type Bearer

      Please enter a valid token

      Query parameters
      StoreId
      integer (int32)
      CardNumberFrom
      integer (int64)
      CardNumberTo
      integer (int64)
      CardAlias
      string
      DigitalOnly
      string
      Valid values[ "All", "Yes", "No" ]
      LoyaltyCardTypeId
      integer (int32)
      CustomerId
      integer (int32)
      IsTransferredOnly
      string
      Valid values[ "All", "Yes", "No" ]
      VerificationCode
      string
      Status
      string
      Valid values[ "NotSpecified", "New", "Reserved", "Active", "Blocked", "Cancelled" ]
      MinimumPriceBalance
      number (double)
      MinimumPointsBalance
      integer (int32)
      MinimumPointsWithdrawalMoneyBalance
      number (double)
      LastModifiedDateFrom
      string (date-time)
      LastModifiedDateTo
      string (date-time)
      LastTransactionModifiedDateFrom
      string (date-time)
      LastTransactionModifiedDateTo
      string (date-time)
      CustomerNumber
      integer (int64)
      CustomerStreet
      string
      CustomerStreetNumberPart1
      integer (int32)
      CustomerStreetNumberPart2
      string
      CustomerCity
      string
      CustomerZipCode
      string
      CustomerFirstName
      string
      CustomerMiddleName
      string
      CustomerLastName
      string
      CustomerGeneralName
      string
      IsSmartSearch
      boolean
      WithCustomerOnly
      string
      Valid values[ "All", "Yes", "No" ]
      CustomerWithAddressOnly
      string
      Valid values[ "All", "Yes", "No" ]
      LastPrintedDateFrom
      string (date-time)
      LastRegistrationReminderSinceDaysOrMore
      integer (int32)
      RegistrationSentReminders
      integer (int32)
      MinimumPrintedPointsBalance
      integer (int32)
      MinimumPrintedPriceBalance
      number (double)
      OnlyWithEmailAddress
      string
      Valid values[ "All", "Yes", "No" ]
      Offset
      integer (int32)
      RecordCount
      integer (int32)
      ItemId
      integer (int32)
      IncludeItemId
      integer (int32)
      ExcludeItemId
      integer (int32)
      ModifiedSinceDateTime
      string (date-time)
      Responses
      200

      Success

      Array of object
      object
      itemId
      integer (int32)
      createdByUserId
      integer (int32)
      createdDateTime
      string (date-time)
      lastModifiedByUserId
      integer (int32)
      lastModifiedDateTime
      string (date-time)
      companyId
      integer (int32)
      storeId
      integer (int32)
      cardNumber
      integer (int64)
      digital
      boolean
      Default"False"
      loyaltyCardTypeId
      integer (int32)
      customerId
      integer (int32)
      status
      string
      Valid values[ "NotSpecified", "New", "Reserved", "Active", "Blocked", "Cancelled" ]
      blockedDescription
      string
      isTransferred
      boolean
      Default"False"
      verificationCode
      string
      registrationEmailAddress
      string
      lastSentRegistrationEmail
      string (date-time)
      numberOfSentRegistrationEmails
      integer (int32)
      lastPrintedDateTime
      string (date-time)
      lastPrintedPointsBalance
      integer (int32)
      lastPrintedPriceBalance
      number (double)
      loyaltyCardTypeDescription
      string
      loyaltyCardType
      string
      Valid values[ "NotSpecified", "Identification", "Points", "Price" ]
      pointWithdrawPrice
      number (double)
      totalSavedPoints
      integer (int32)
      totalSavedPrice
      number (double)
      totalWithdrawedPoints
      integer (int32)
      totalWithdrawedPrice
      number (double)
      totalExpiredPoints
      integer (int32)
      currentBalancePointsMoneyValue
      number (double)
      customerNumber
      integer (int64)
      generalName
      string
      Array of object
      object
      itemId
      integer (int32)
      createdByUserId
      integer (int32)
      createdDateTime
      string (date-time)
      lastModifiedByUserId
      integer (int32)
      lastModifiedDateTime
      string (date-time)
      companyId
      integer (int32)
      storeId
      integer (int32)
      cardNumber
      integer (int64)
      digital
      boolean
      Default"False"
      loyaltyCardTypeId
      integer (int32)
      customerId
      integer (int32)
      status
      string
      Valid values[ "NotSpecified", "New", "Reserved", "Active", "Blocked", "Cancelled" ]
      blockedDescription
      string
      isTransferred
      boolean
      Default"False"
      verificationCode
      string
      registrationEmailAddress
      string
      lastSentRegistrationEmail
      string (date-time)
      numberOfSentRegistrationEmails
      integer (int32)
      lastPrintedDateTime
      string (date-time)
      lastPrintedPointsBalance
      integer (int32)
      lastPrintedPriceBalance
      number (double)
      loyaltyCardTypeDescription
      string
      loyaltyCardType
      string
      Valid values[ "NotSpecified", "Identification", "Points", "Price" ]
      pointWithdrawPrice
      number (double)
      totalSavedPoints
      integer (int32)
      totalSavedPrice
      number (double)
      totalWithdrawedPoints
      integer (int32)
      totalWithdrawedPrice
      number (double)
      totalExpiredPoints
      integer (int32)
      currentBalancePointsMoneyValue
      number (double)
      customerNumber
      integer (int64)
      generalName
      string
      Array of object
      object
      itemId
      integer (int32)
      createdByUserId
      integer (int32)
      createdDateTime
      string (date-time)
      lastModifiedByUserId
      integer (int32)
      lastModifiedDateTime
      string (date-time)
      companyId
      integer (int32)
      storeId
      integer (int32)
      cardNumber
      integer (int64)
      digital
      boolean
      Default"False"
      loyaltyCardTypeId
      integer (int32)
      customerId
      integer (int32)
      status
      string
      Valid values[ "NotSpecified", "New", "Reserved", "Active", "Blocked", "Cancelled" ]
      blockedDescription
      string
      isTransferred
      boolean
      Default"False"
      verificationCode
      string
      registrationEmailAddress
      string
      lastSentRegistrationEmail
      string (date-time)
      numberOfSentRegistrationEmails
      integer (int32)
      lastPrintedDateTime
      string (date-time)
      lastPrintedPointsBalance
      integer (int32)
      lastPrintedPriceBalance
      number (double)
      loyaltyCardTypeDescription
      string
      loyaltyCardType
      string
      Valid values[ "NotSpecified", "Identification", "Points", "Price" ]
      pointWithdrawPrice
      number (double)
      totalSavedPoints
      integer (int32)
      totalSavedPrice
      number (double)
      totalWithdrawedPoints
      integer (int32)
      totalWithdrawedPrice
      number (double)
      totalExpiredPoints
      integer (int32)
      currentBalancePointsMoneyValue
      number (double)
      customerNumber
      integer (int64)
      generalName
      string
      401

      Unauthorized

      object
      type
      string
      message
      string
      stackTrace
      string
      object
      type
      string
      message
      string
      stackTrace
      string
      object
      type
      string
      message
      string
      stackTrace
      string
      403

      Forbidden

      object
      type
      string
      message
      string
      stackTrace
      string
      object
      type
      string
      message
      string
      stackTrace
      string
      object
      type
      string
      message
      string
      stackTrace
      string
      404

      Not Found

      object
      type
      string
      message
      string
      stackTrace
      string
      object
      type
      string
      message
      string
      stackTrace
      string
      object
      type
      string
      message
      string
      stackTrace
      string
      Was this article helpful?
      What's Next
      Change password!
      Changing your password will log you out immediately. Use the new password to log back in.
      Change profile
      Success!
      First name must have atleast 2 characters. Numbers and special characters are not allowed.
      Last name must have atleast 1 characters. Numbers and special characters are not allowed.
      Enter a valid email
      Enter a valid password
      Your profile has been successfully updated.
      Logout