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

      /v23.1/GiftCards

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

      Get
      /v23.1/GiftCards
      Security
      HTTP
      Type Bearer

      Please enter a valid token

      Query parameters
      StoreId
      integer (int32)
      GiftCardTypeId
      integer (int32)
      GiftCardDefinitionId
      integer (int32)
      CustomerId
      integer (int32)
      SaleOrderId
      integer (int32)
      ReservationId
      integer (int32)
      ReservationRowId
      integer (int32)
      CashSaleId
      integer (int32)
      InvoiceSaleId
      integer (int32)
      CardNumber
      integer (int64)
      CardNumberWithSuffix
      integer (int64)
      CardNumberFrom
      integer (int64)
      CardNumberTo
      integer (int64)
      VerificationCode
      string
      Status
      string
      Valid values[ "NotSpecified", "Active", "Blocked", "NotActivated" ]
      IsPrintedOnly
      string
      Valid values[ "All", "Yes", "No" ]
      IsBlockedOnly
      string
      Valid values[ "All", "Yes", "No" ]
      CreatedDateFrom
      string (date-time)
      CreatedDateTo
      string (date-time)
      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)
      giftCardTypeId
      integer (int32)
      giftCardDefinitionId
      integer (int32)
      customerId
      integer (int32)
      reservationRowId
      integer (int32)
      cashSaleId
      integer (int32)
      invoiceSaleId
      integer (int32)
      prefix
      integer (int64)
      cardNumber
      integer (int64)
      suffix
      integer (int32)
      cardNumberWithSuffix
      integer (int64)
      email
      string
      pincode
      integer (int32)
      verificationCode
      string
      status
      string
      Valid values[ "NotSpecified", "Active", "Blocked", "NotActivated" ]
      isBlocked
      boolean
      Default"False"
      blockedDescription
      string
      transactions
      integer (int32)
      activationDate
      string (date-time)
      printedDate
      string (date-time)
      balance
      number (double)
      giftCardDefinitionDescription
      string
      initialBalance
      number (double)
      maxTransactions
      integer (int32)
      allowCashRevert
      boolean
      Default"False"
      allowIgnoreExpiry
      boolean
      Default"False"
      expiryDate
      string (date-time)
      transactionsRemaining
      integer (int32)
      giftCardTypeDescription
      string
      customerName
      string
      customerNumber
      integer (int64)
      reservationNumber
      integer (int32)
      saleOrderNumber
      integer (int32)
      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)
      giftCardTypeId
      integer (int32)
      giftCardDefinitionId
      integer (int32)
      customerId
      integer (int32)
      reservationRowId
      integer (int32)
      cashSaleId
      integer (int32)
      invoiceSaleId
      integer (int32)
      prefix
      integer (int64)
      cardNumber
      integer (int64)
      suffix
      integer (int32)
      cardNumberWithSuffix
      integer (int64)
      email
      string
      pincode
      integer (int32)
      verificationCode
      string
      status
      string
      Valid values[ "NotSpecified", "Active", "Blocked", "NotActivated" ]
      isBlocked
      boolean
      Default"False"
      blockedDescription
      string
      transactions
      integer (int32)
      activationDate
      string (date-time)
      printedDate
      string (date-time)
      balance
      number (double)
      giftCardDefinitionDescription
      string
      initialBalance
      number (double)
      maxTransactions
      integer (int32)
      allowCashRevert
      boolean
      Default"False"
      allowIgnoreExpiry
      boolean
      Default"False"
      expiryDate
      string (date-time)
      transactionsRemaining
      integer (int32)
      giftCardTypeDescription
      string
      customerName
      string
      customerNumber
      integer (int64)
      reservationNumber
      integer (int32)
      saleOrderNumber
      integer (int32)
      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)
      giftCardTypeId
      integer (int32)
      giftCardDefinitionId
      integer (int32)
      customerId
      integer (int32)
      reservationRowId
      integer (int32)
      cashSaleId
      integer (int32)
      invoiceSaleId
      integer (int32)
      prefix
      integer (int64)
      cardNumber
      integer (int64)
      suffix
      integer (int32)
      cardNumberWithSuffix
      integer (int64)
      email
      string
      pincode
      integer (int32)
      verificationCode
      string
      status
      string
      Valid values[ "NotSpecified", "Active", "Blocked", "NotActivated" ]
      isBlocked
      boolean
      Default"False"
      blockedDescription
      string
      transactions
      integer (int32)
      activationDate
      string (date-time)
      printedDate
      string (date-time)
      balance
      number (double)
      giftCardDefinitionDescription
      string
      initialBalance
      number (double)
      maxTransactions
      integer (int32)
      allowCashRevert
      boolean
      Default"False"
      allowIgnoreExpiry
      boolean
      Default"False"
      expiryDate
      string (date-time)
      transactionsRemaining
      integer (int32)
      giftCardTypeDescription
      string
      customerName
      string
      customerNumber
      integer (int64)
      reservationNumber
      integer (int32)
      saleOrderNumber
      integer (int32)
      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