POST GiftCardReport/GenerateSummaryReport

Request Information

URI Parameters

None.

Body Parameters

IConnect.Domain.Reports.ProductReport.GiftCardReport.ReportViewModel
NameDescriptionTypeAdditional information
MassCreditType

integer

None.
MassCreditAmount

decimal number

None.
GiftCardCode

string

None.
ShowDeleted

boolean

None.
GiftCardType

integer

None.
GiftCardDisplayType

IConnect.Domain.Reports.Products.GiftCardReport.GiftCardDisplayTypeEnum

None.
CustomerName

string

None.
StartingGiftCardNumber

integer

None.
EndingGiftCardNumber

integer

None.
ShowSummaryReport

boolean

None.
CustomerId

integer

None.
PageSize

integer

None.
PageIndex

integer

None.
CustomPaymentMethodId

integer

None.
SelectedCompanies

Collection of integer

None.
OrderSource

IConnect.Domain.Orders.DisplayOrderSource

None.
Start

date

None.
End

date

None.
StartDateObjectString

string

None.
EndDateObjectString

string

None.
SkipTimeZoneConvertion

boolean

None.
ForceImmediateExport

boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "MassCreditType": 1,
  "MassCreditAmount": 2.0,
  "GiftCardCode": "sample string 3",
  "ShowDeleted": true,
  "GiftCardType": 1,
  "GiftCardDisplayType": 0,
  "CustomerName": "sample string 5",
  "StartingGiftCardNumber": 1,
  "EndingGiftCardNumber": 1,
  "ShowSummaryReport": true,
  "CustomerId": 1,
  "PageSize": 1,
  "PageIndex": 1,
  "CustomPaymentMethodId": 1,
  "SelectedCompanies": [
    1,
    2
  ],
  "OrderSource": 1,
  "Start": "2024-10-18T04:33:15.6299804-04:00",
  "End": "2024-10-18T04:33:15.6299804-04:00",
  "StartDateObjectString": "{\"year\":2024,\"month\":10,\"date\":18,\"hours\":4,\"minutes\":33,\"seconds\":15,\"miliseconds\":629}",
  "EndDateObjectString": "{\"year\":2024,\"month\":10,\"date\":18,\"hours\":4,\"minutes\":33,\"seconds\":15,\"miliseconds\":629}",
  "SkipTimeZoneConvertion": true,
  "ForceImmediateExport": true
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of IConnect.Domain.Reports.ProductReport.GiftCardReport.SummaryReportItem
NameDescriptionTypeAdditional information
LocationId

integer

None.
Location

string

None.
SoldAmount

decimal number

None.
RedeemedAmount

decimal number

None.
Outstanding

decimal number

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "LocationId": 1,
    "Location": "sample string 2",
    "SoldAmount": 3.0,
    "RedeemedAmount": 4.0,
    "Outstanding": -1.0
  },
  {
    "LocationId": 1,
    "Location": "sample string 2",
    "SoldAmount": 3.0,
    "RedeemedAmount": 4.0,
    "Outstanding": -1.0
  }
]

application/xml, text/xml

Sample: 
<ArrayOfSummaryReportItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports.ProductReport.GiftCardReport">
  <SummaryReportItem>
    <Location>sample string 2</Location>
    <LocationId>1</LocationId>
    <RedeemedAmount>4</RedeemedAmount>
    <SoldAmount>3</SoldAmount>
  </SummaryReportItem>
  <SummaryReportItem>
    <Location>sample string 2</Location>
    <LocationId>1</LocationId>
    <RedeemedAmount>4</RedeemedAmount>
    <SoldAmount>3</SoldAmount>
  </SummaryReportItem>
</ArrayOfSummaryReportItem>