POST ProductSubscriptionReport/GenerateReportView

Request Information

URI Parameters

None.

Body Parameters

IConnect.Domain.Reports.ProductReport.ProductSubscriptionReport.ReportViewModel

Name	Type	Additional information
SKU	Collection of string	None.
CustomersCriteria	string	None.
SearchTerm	string	None.
PageIndex	integer	None.
PageSize	integer	None.
TotalRows	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:

{
  "SKU": [
    "sample string 1",
    "sample string 2"
  ],
  "CustomersCriteria": "sample string 1",
  "SearchTerm": "sample string 2",
  "PageIndex": 1,
  "PageSize": 1,
  "TotalRows": 3,
  "SelectedCompanies": [
    1,
    2
  ],
  "OrderSource": 1,
  "Start": "2025-04-03T22:03:31.7100355-04:00",
  "End": "2025-04-03T22:03:31.7100355-04:00",
  "StartDateObjectString": "{\"year\":2025,\"month\":4,\"date\":3,\"hours\":22,\"minutes\":3,\"seconds\":31,\"miliseconds\":710}",
  "EndDateObjectString": "{\"year\":2025,\"month\":4,\"date\":3,\"hours\":22,\"minutes\":3,\"seconds\":31,\"miliseconds\":710}",
  "SkipTimeZoneConvertion": true,
  "ForceImmediateExport": true
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IConnect.Core.PagedListOfIConnect.Domain.Reports.ProductReport.ProductSubscriptionReport.LocationReportItem

Name	Type	Additional information
Data	Collection of IConnect.Domain.Reports.ProductReport.ProductSubscriptionReport.LocationReportItem	None.
Footer	IConnect.Domain.Reports.ProductReport.ProductSubscriptionReport.LocationReportItem	None.
PageFooter	IConnect.Domain.Reports.ProductReport.ProductSubscriptionReport.LocationReportItem	None.
PageNumber	integer	None.
PageSize	integer	None.
TotalRows	integer	None.
TotalPages	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Data": [
    null,
    {
      "Id": 1,
      "LocationId": 2,
      "LocationName": "sample string 3",
      "Total": 4.0,
      "Date": "2025-04-03T22:03:31.7256612-04:00",
      "StartDate": "2025-04-03T22:03:31.7256612-04:00",
      "DateString": "sample string 6",
      "StartDateString": "sample string 7",
      "DateDateObject": {
        "year": 1,
        "month": 2,
        "date": 3,
        "hours": 4,
        "minutes": 5,
        "seconds": 6,
        "miliseconds": 7
      },
      "Frequency": "sample string 8",
      "Status": 0,
      "FrequencyTypeId": 9,
      "CustomFrequencyValue": 1,
      "CustomerName": "sample string 10",
      "CustomerPhone": "sample string 11",
      "ProductId": 12,
      "ProductName": "sample string 13",
      "Sku": "sample string 14",
      "ShippingOption": 0,
      "ShippingOptionName": "In-store",
      "ShipEngineCarrier": "sample string 16",
      "ShipEngineServiceType": "sample string 17",
      "AdditionalSettings": "sample string 18",
      "Quantity": 19.0,
      "Price": 20.0,
      "QuantityText": "19",
      "StockUnit": 0,
      "SubscriptionOptions": [
        {
          "id": {},
          "name": "sample string 2"
        },
        {
          "id": {},
          "name": "sample string 2"
        }
      ],
      "NextChargeDateObjectString": "{\"year\":2025,\"month\":4,\"date\":3,\"hours\":22,\"minutes\":3,\"seconds\":31,\"miliseconds\":725}",
      "ErrorMessage": null,
      "StatusText": "None",
      "ModifiedDate": null,
      "ModifiedBy": null,
      "StatusInfo": null
    }
  ],
  "Footer": {
    "Id": 1,
    "LocationId": 2,
    "LocationName": "sample string 3",
    "Total": 4.0,
    "Date": "2025-04-03T22:03:31.7256612-04:00",
    "StartDate": "2025-04-03T22:03:31.7256612-04:00",
    "DateString": "sample string 6",
    "StartDateString": "sample string 7",
    "DateDateObject": {
      "year": 1,
      "month": 2,
      "date": 3,
      "hours": 4,
      "minutes": 5,
      "seconds": 6,
      "miliseconds": 7
    },
    "Frequency": "sample string 8",
    "Status": 0,
    "FrequencyTypeId": 9,
    "CustomFrequencyValue": 1,
    "CustomerName": "sample string 10",
    "CustomerPhone": "sample string 11",
    "ProductId": 12,
    "ProductName": "sample string 13",
    "Sku": "sample string 14",
    "ShippingOption": 0,
    "ShippingOptionName": "In-store",
    "ShipEngineCarrier": "sample string 16",
    "ShipEngineServiceType": "sample string 17",
    "AdditionalSettings": "sample string 18",
    "Quantity": 19.0,
    "Price": 20.0,
    "QuantityText": "19",
    "StockUnit": 0,
    "SubscriptionOptions": [
      {
        "id": {},
        "name": "sample string 2"
      },
      {
        "id": {},
        "name": "sample string 2"
      }
    ],
    "NextChargeDateObjectString": "{\"year\":2025,\"month\":4,\"date\":3,\"hours\":22,\"minutes\":3,\"seconds\":31,\"miliseconds\":725}",
    "ErrorMessage": null,
    "StatusText": "None",
    "ModifiedDate": null,
    "ModifiedBy": null,
    "StatusInfo": null
  },
  "PageFooter": {
    "Id": 1,
    "LocationId": 2,
    "LocationName": "sample string 3",
    "Total": 4.0,
    "Date": "2025-04-03T22:03:31.7256612-04:00",
    "StartDate": "2025-04-03T22:03:31.7256612-04:00",
    "DateString": "sample string 6",
    "StartDateString": "sample string 7",
    "DateDateObject": {
      "year": 1,
      "month": 2,
      "date": 3,
      "hours": 4,
      "minutes": 5,
      "seconds": 6,
      "miliseconds": 7
    },
    "Frequency": "sample string 8",
    "Status": 0,
    "FrequencyTypeId": 9,
    "CustomFrequencyValue": 1,
    "CustomerName": "sample string 10",
    "CustomerPhone": "sample string 11",
    "ProductId": 12,
    "ProductName": "sample string 13",
    "Sku": "sample string 14",
    "ShippingOption": 0,
    "ShippingOptionName": "In-store",
    "ShipEngineCarrier": "sample string 16",
    "ShipEngineServiceType": "sample string 17",
    "AdditionalSettings": "sample string 18",
    "Quantity": 19.0,
    "Price": 20.0,
    "QuantityText": "19",
    "StockUnit": 0,
    "SubscriptionOptions": [
      {
        "id": {},
        "name": "sample string 2"
      },
      {
        "id": {},
        "name": "sample string 2"
      }
    ],
    "NextChargeDateObjectString": "{\"year\":2025,\"month\":4,\"date\":3,\"hours\":22,\"minutes\":3,\"seconds\":31,\"miliseconds\":725}",
    "ErrorMessage": null,
    "StatusText": "None",
    "ModifiedDate": null,
    "ModifiedBy": null,
    "StatusInfo": null
  },
  "PageNumber": 1,
  "PageSize": 2,
  "TotalRows": 3,
  "TotalPages": 4
}

application/xml, text/xml

Sample:

<PagedListOfLocationReportItemOs6mm1kC xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Core">
  <PageNumber>1</PageNumber>
  <PageSize>2</PageSize>
  <TotalPages>4</TotalPages>
  <TotalRows>3</TotalRows>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports.ProductReport.ProductSubscriptionReport">
    <d2p1:LocationReportItem i:nil="true" />
    <d2p1:LocationReportItem>
      <d2p1:AdditionalSettings>sample string 18</d2p1:AdditionalSettings>
      <d2p1:CustomFrequencyValue>1</d2p1:CustomFrequencyValue>
      <d2p1:CustomerName>sample string 10</d2p1:CustomerName>
      <d2p1:CustomerPhone>sample string 11</d2p1:CustomerPhone>
      <d2p1:Date>2025-04-03T22:03:31.7256612-04:00</d2p1:Date>
      <d2p1:DateDateObject xmlns:d4p1="http://schemas.datacontract.org/2004/07/IConnect.Core.Entities">
        <d4p1:Date>3</d4p1:Date>
        <d4p1:Hours>4</d4p1:Hours>
        <d4p1:Miliseconds>7</d4p1:Miliseconds>
        <d4p1:Minutes>5</d4p1:Minutes>
        <d4p1:Month>2</d4p1:Month>
        <d4p1:Seconds>6</d4p1:Seconds>
        <d4p1:Year>1</d4p1:Year>
      </d2p1:DateDateObject>
      <d2p1:DateString>sample string 6</d2p1:DateString>
      <d2p1:ErrorMessage i:nil="true" />
      <d2p1:Frequency>sample string 8</d2p1:Frequency>
      <d2p1:FrequencyTypeId>9</d2p1:FrequencyTypeId>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:LocationId>2</d2p1:LocationId>
      <d2p1:LocationName>sample string 3</d2p1:LocationName>
      <d2p1:ModifiedBy i:nil="true" />
      <d2p1:ModifiedDate i:nil="true" />
      <d2p1:NextChargeDateObjectString>{"year":2025,"month":4,"date":3,"hours":22,"minutes":3,"seconds":31,"miliseconds":725}</d2p1:NextChargeDateObjectString>
      <d2p1:Price>20</d2p1:Price>
      <d2p1:ProductId>12</d2p1:ProductId>
      <d2p1:ProductName>sample string 13</d2p1:ProductName>
      <d2p1:Quantity>19</d2p1:Quantity>
      <d2p1:ShipEngineCarrier>sample string 16</d2p1:ShipEngineCarrier>
      <d2p1:ShipEngineServiceName>sample string 15</d2p1:ShipEngineServiceName>
      <d2p1:ShipEngineServiceType>sample string 17</d2p1:ShipEngineServiceType>
      <d2p1:ShippingOption>InStore</d2p1:ShippingOption>
      <d2p1:Sku>sample string 14</d2p1:Sku>
      <d2p1:StartDate>2025-04-03T22:03:31.7256612-04:00</d2p1:StartDate>
      <d2p1:StartDateString>sample string 7</d2p1:StartDateString>
      <d2p1:Status>None</d2p1:Status>
      <d2p1:StatusInfo i:nil="true" />
      <d2p1:StockUnit>Each</d2p1:StockUnit>
      <d2p1:SubscriptionOptions>
        <JsonSimpleViewModel>
          <Id />
          <Name>sample string 2</Name>
        </JsonSimpleViewModel>
        <JsonSimpleViewModel>
          <Id />
          <Name>sample string 2</Name>
        </JsonSimpleViewModel>
      </d2p1:SubscriptionOptions>
      <d2p1:Total>4</d2p1:Total>
    </d2p1:LocationReportItem>
  </Data>
  <Footer xmlns:d2p1="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports.ProductReport.ProductSubscriptionReport">
    <d2p1:AdditionalSettings>sample string 18</d2p1:AdditionalSettings>
    <d2p1:CustomFrequencyValue>1</d2p1:CustomFrequencyValue>
    <d2p1:CustomerName>sample string 10</d2p1:CustomerName>
    <d2p1:CustomerPhone>sample string 11</d2p1:CustomerPhone>
    <d2p1:Date>2025-04-03T22:03:31.7256612-04:00</d2p1:Date>
    <d2p1:DateDateObject xmlns:d3p1="http://schemas.datacontract.org/2004/07/IConnect.Core.Entities">
      <d3p1:Date>3</d3p1:Date>
      <d3p1:Hours>4</d3p1:Hours>
      <d3p1:Miliseconds>7</d3p1:Miliseconds>
      <d3p1:Minutes>5</d3p1:Minutes>
      <d3p1:Month>2</d3p1:Month>
      <d3p1:Seconds>6</d3p1:Seconds>
      <d3p1:Year>1</d3p1:Year>
    </d2p1:DateDateObject>
    <d2p1:DateString>sample string 6</d2p1:DateString>
    <d2p1:ErrorMessage i:nil="true" />
    <d2p1:Frequency>sample string 8</d2p1:Frequency>
    <d2p1:FrequencyTypeId>9</d2p1:FrequencyTypeId>
    <d2p1:Id>1</d2p1:Id>
    <d2p1:LocationId>2</d2p1:LocationId>
    <d2p1:LocationName>sample string 3</d2p1:LocationName>
    <d2p1:ModifiedBy i:nil="true" />
    <d2p1:ModifiedDate i:nil="true" />
    <d2p1:NextChargeDateObjectString>{"year":2025,"month":4,"date":3,"hours":22,"minutes":3,"seconds":31,"miliseconds":725}</d2p1:NextChargeDateObjectString>
    <d2p1:Price>20</d2p1:Price>
    <d2p1:ProductId>12</d2p1:ProductId>
    <d2p1:ProductName>sample string 13</d2p1:ProductName>
    <d2p1:Quantity>19</d2p1:Quantity>
    <d2p1:ShipEngineCarrier>sample string 16</d2p1:ShipEngineCarrier>
    <d2p1:ShipEngineServiceName>sample string 15</d2p1:ShipEngineServiceName>
    <d2p1:ShipEngineServiceType>sample string 17</d2p1:ShipEngineServiceType>
    <d2p1:ShippingOption>InStore</d2p1:ShippingOption>
    <d2p1:Sku>sample string 14</d2p1:Sku>
    <d2p1:StartDate>2025-04-03T22:03:31.7256612-04:00</d2p1:StartDate>
    <d2p1:StartDateString>sample string 7</d2p1:StartDateString>
    <d2p1:Status>None</d2p1:Status>
    <d2p1:StatusInfo i:nil="true" />
    <d2p1:StockUnit>Each</d2p1:StockUnit>
    <d2p1:SubscriptionOptions>
      <JsonSimpleViewModel>
        <Id />
        <Name>sample string 2</Name>
      </JsonSimpleViewModel>
      <JsonSimpleViewModel>
        <Id />
        <Name>sample string 2</Name>
      </JsonSimpleViewModel>
    </d2p1:SubscriptionOptions>
    <d2p1:Total>4</d2p1:Total>
  </Footer>
  <PageFooter xmlns:d2p1="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports.ProductReport.ProductSubscriptionReport">
    <d2p1:AdditionalSettings>sample string 18</d2p1:AdditionalSettings>
    <d2p1:CustomFrequencyValue>1</d2p1:CustomFrequencyValue>
    <d2p1:CustomerName>sample string 10</d2p1:CustomerName>
    <d2p1:CustomerPhone>sample string 11</d2p1:CustomerPhone>
    <d2p1:Date>2025-04-03T22:03:31.7256612-04:00</d2p1:Date>
    <d2p1:DateDateObject xmlns:d3p1="http://schemas.datacontract.org/2004/07/IConnect.Core.Entities">
      <d3p1:Date>3</d3p1:Date>
      <d3p1:Hours>4</d3p1:Hours>
      <d3p1:Miliseconds>7</d3p1:Miliseconds>
      <d3p1:Minutes>5</d3p1:Minutes>
      <d3p1:Month>2</d3p1:Month>
      <d3p1:Seconds>6</d3p1:Seconds>
      <d3p1:Year>1</d3p1:Year>
    </d2p1:DateDateObject>
    <d2p1:DateString>sample string 6</d2p1:DateString>
    <d2p1:ErrorMessage i:nil="true" />
    <d2p1:Frequency>sample string 8</d2p1:Frequency>
    <d2p1:FrequencyTypeId>9</d2p1:FrequencyTypeId>
    <d2p1:Id>1</d2p1:Id>
    <d2p1:LocationId>2</d2p1:LocationId>
    <d2p1:LocationName>sample string 3</d2p1:LocationName>
    <d2p1:ModifiedBy i:nil="true" />
    <d2p1:ModifiedDate i:nil="true" />
    <d2p1:NextChargeDateObjectString>{"year":2025,"month":4,"date":3,"hours":22,"minutes":3,"seconds":31,"miliseconds":725}</d2p1:NextChargeDateObjectString>
    <d2p1:Price>20</d2p1:Price>
    <d2p1:ProductId>12</d2p1:ProductId>
    <d2p1:ProductName>sample string 13</d2p1:ProductName>
    <d2p1:Quantity>19</d2p1:Quantity>
    <d2p1:ShipEngineCarrier>sample string 16</d2p1:ShipEngineCarrier>
    <d2p1:ShipEngineServiceName>sample string 15</d2p1:ShipEngineServiceName>
    <d2p1:ShipEngineServiceType>sample string 17</d2p1:ShipEngineServiceType>
    <d2p1:ShippingOption>InStore</d2p1:ShippingOption>
    <d2p1:Sku>sample string 14</d2p1:Sku>
    <d2p1:StartDate>2025-04-03T22:03:31.7256612-04:00</d2p1:StartDate>
    <d2p1:StartDateString>sample string 7</d2p1:StartDateString>
    <d2p1:Status>None</d2p1:Status>
    <d2p1:StatusInfo i:nil="true" />
    <d2p1:StockUnit>Each</d2p1:StockUnit>
    <d2p1:SubscriptionOptions>
      <JsonSimpleViewModel>
        <Id />
        <Name>sample string 2</Name>
      </JsonSimpleViewModel>
      <JsonSimpleViewModel>
        <Id />
        <Name>sample string 2</Name>
      </JsonSimpleViewModel>
    </d2p1:SubscriptionOptions>
    <d2p1:Total>4</d2p1:Total>
  </PageFooter>
</PagedListOfLocationReportItemOs6mm1kC>

URI parameters

Headers | Add header

Body

Status

Headers

Body

POST ProductSubscriptionReport/GenerateReportView

Request Information

URI Parameters

Body Parameters

Request Formats

application/json, text/json

application/x-www-form-urlencoded

Response Information

Resource Description

Response Formats

application/json, text/json

application/xml, text/xml