POST api/GiftCardOps/GetGiftCardReport

GetGiftCardReport reports merchant specific gift card statuses.

Request Information

URI Parameters

None.

Body Parameters

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

Request Formats

application/json, text/json

Sample:

{
  "ClientID": 1,
  "StartDate": "2025-05-03T18:15:00.8503378+00:00",
  "EndDate": "2025-05-03T18:15:00.8503378+00:00"
}

application/xml, text/xml

Sample:

<GetGiftCardReportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GiftCardAPIData"><ClientID>1</ClientID><EndDate>2025-05-03T18:15:00.8503378+00:00</EndDate><StartDate>2025-05-03T18:15:00.8503378+00:00</StartDate></GetGiftCardReportRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetGiftCardReportResponse

Name	Type	Additional information
Success	boolean	None.
ErrorMessage	string	None.
ReportDetails	Collection of GiftCardReportEntry	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "ErrorMessage": "sample string 2",
  "ReportDetails": [
    {
      "DisplayName": "sample string 1",
      "Name": "sample string 2",
      "Value": "sample string 3"
    },
    {
      "DisplayName": "sample string 1",
      "Name": "sample string 2",
      "Value": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:

<GetGiftCardReportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GiftCardAPIData"><ErrorMessage>sample string 2</ErrorMessage><ReportDetails><GiftCardReportEntry><DisplayName>sample string 1</DisplayName><Name>sample string 2</Name><Value>sample string 3</Value></GiftCardReportEntry><GiftCardReportEntry><DisplayName>sample string 1</DisplayName><Name>sample string 2</Name><Value>sample string 3</Value></GiftCardReportEntry></ReportDetails><Success>true</Success></GetGiftCardReportResponse>