POST api/GiftCardOps/GetGiftCardTransactionsByDateRange

GetGiftCardTransactionsByDateRange returns all gift card transactions in the date range provided for the clientID in the request.

Request Information

URI Parameters

None.

Body Parameters

GetGiftCardTransactionsByDateRangeRequest

Name	Type	Additional information
ClientID	integer	None.
StartDate	date	None.
EndDate	date	None.
IncludeGiftCardGroup	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "ClientID": 1,
  "StartDate": "2025-05-06T00:51:28.2727756+00:00",
  "EndDate": "2025-05-06T00:51:28.2727756+00:00",
  "IncludeGiftCardGroup": true
}

application/xml, text/xml

Sample:

<GetGiftCardTransactionsByDateRangeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GiftCardAPIData"><ClientID>1</ClientID><EndDate>2025-05-06T00:51:28.2727756+00:00</EndDate><IncludeGiftCardGroup>true</IncludeGiftCardGroup><StartDate>2025-05-06T00:51:28.2727756+00:00</StartDate></GetGiftCardTransactionsByDateRangeRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetGiftCardTransactionsByDateRangeResponse

Name	Type	Additional information
Success	boolean	None.
ErrorMessage	string	None.
GiftCards	Collection of GiftCard	None.
GiftCardTransactionTypes	Collection of GiftCardTransactionType	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "ErrorMessage": "sample string 2",
  "GiftCards": [
    {
      "ID": 1,
      "Transactions": [
        {
          "ID": 1,
          "GiftCardTransactionTypeID": 2,
          "BalanceChange": 3.0,
          "POSTransactionIdent": 4,
          "Timestamp": "2025-05-06T00:51:28.3040248+00:00"
        },
        {
          "ID": 1,
          "GiftCardTransactionTypeID": 2,
          "BalanceChange": 3.0,
          "POSTransactionIdent": 4,
          "Timestamp": "2025-05-06T00:51:28.3040248+00:00"
        }
      ],
      "ClientID": 2,
      "PurchasingUnifiedCustomerID": 3,
      "CardNumberLast4": "sample string 4",
      "CardNumber": "sample string 5",
      "Balance": 6.0
    },
    {
      "ID": 1,
      "Transactions": [
        {
          "ID": 1,
          "GiftCardTransactionTypeID": 2,
          "BalanceChange": 3.0,
          "POSTransactionIdent": 4,
          "Timestamp": "2025-05-06T00:51:28.3040248+00:00"
        },
        {
          "ID": 1,
          "GiftCardTransactionTypeID": 2,
          "BalanceChange": 3.0,
          "POSTransactionIdent": 4,
          "Timestamp": "2025-05-06T00:51:28.3040248+00:00"
        }
      ],
      "ClientID": 2,
      "PurchasingUnifiedCustomerID": 3,
      "CardNumberLast4": "sample string 4",
      "CardNumber": "sample string 5",
      "Balance": 6.0
    }
  ],
  "GiftCardTransactionTypes": [
    {
      "ID": 1,
      "Name": "sample string 2"
    },
    {
      "ID": 1,
      "Name": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<GetGiftCardTransactionsByDateRangeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GiftCardAPIData"><ErrorMessage>sample string 2</ErrorMessage><GiftCardTransactionTypes><GiftCardTransactionType><ID>1</ID><Name>sample string 2</Name></GiftCardTransactionType><GiftCardTransactionType><ID>1</ID><Name>sample string 2</Name></GiftCardTransactionType></GiftCardTransactionTypes><GiftCards><GiftCard><Balance>6</Balance><CardNumber>sample string 5</CardNumber><CardNumberLast4>sample string 4</CardNumberLast4><ClientID>2</ClientID><ID>1</ID><PurchasingUnifiedCustomerID>3</PurchasingUnifiedCustomerID><Transactions><GiftCardTransaction><BalanceChange>3</BalanceChange><GiftCardTransactionTypeID>2</GiftCardTransactionTypeID><ID>1</ID><POSTransactionIdent>4</POSTransactionIdent><Timestamp>2025-05-06T00:51:28.3040248+00:00</Timestamp></GiftCardTransaction><GiftCardTransaction><BalanceChange>3</BalanceChange><GiftCardTransactionTypeID>2</GiftCardTransactionTypeID><ID>1</ID><POSTransactionIdent>4</POSTransactionIdent><Timestamp>2025-05-06T00:51:28.3040248+00:00</Timestamp></GiftCardTransaction></Transactions></GiftCard><GiftCard><Balance>6</Balance><CardNumber>sample string 5</CardNumber><CardNumberLast4>sample string 4</CardNumberLast4><ClientID>2</ClientID><ID>1</ID><PurchasingUnifiedCustomerID>3</PurchasingUnifiedCustomerID><Transactions><GiftCardTransaction><BalanceChange>3</BalanceChange><GiftCardTransactionTypeID>2</GiftCardTransactionTypeID><ID>1</ID><POSTransactionIdent>4</POSTransactionIdent><Timestamp>2025-05-06T00:51:28.3040248+00:00</Timestamp></GiftCardTransaction><GiftCardTransaction><BalanceChange>3</BalanceChange><GiftCardTransactionTypeID>2</GiftCardTransactionTypeID><ID>1</ID><POSTransactionIdent>4</POSTransactionIdent><Timestamp>2025-05-06T00:51:28.3040248+00:00</Timestamp></GiftCardTransaction></Transactions></GiftCard></GiftCards><Success>true</Success></GetGiftCardTransactionsByDateRangeResponse>