POST api/CustomerAnalysisReport

Get New/Returning Company Customers

Request Information

Allows multi-location processing, in case of using parent location token restrictByLocations parameter is strongly recommended with comma separated list of locations to select from or update in

URI Parameters

None.

Body Parameters

Name	Type	Additional information
StartDate	date	None.
EndDate	date	None.
RestrictByLocations	string	None.
ProductType	ProductType	None.
Category	Collection of integer	None.
SkuList	Collection of string	None.
RetentionType	integer	None.
Sales	decimal number	None.
SalesFilter	NumberComparisonType	None.
AverageTicket	decimal number	None.
AverageTicketFilter	NumberComparisonType	None.
NumberOfTickets	integer	None.
NumberOfTicketsFilter	NumberComparisonType	None.
Ticket	decimal number	None.
TicketFilter	NumberComparisonType	None.
ProductTicket	integer	None.
ProductTicketFilter	NumberComparisonType	None.
TotalSales	decimal number	None.
TotalSalesFilter	NumberComparisonType	None.
IsMember	boolean	None.
CustomerIsNew	boolean	None.
ReceivedDiscount	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "StartDate": "2024-10-18T01:19:42.6531402-04:00",
  "EndDate": "2024-10-18T01:19:42.6531402-04:00",
  "RestrictByLocations": "sample string 1",
  "ProductType": 0,
  "Category": [
    1,
    2
  ],
  "SkuList": [
    "sample string 1",
    "sample string 2"
  ],
  "RetentionType": 2,
  "Sales": 1.0,
  "SalesFilter": 0,
  "AverageTicket": 1.0,
  "AverageTicketFilter": 0,
  "NumberOfTickets": 1,
  "NumberOfTicketsFilter": 0,
  "Ticket": 1.0,
  "TicketFilter": 0,
  "ProductTicket": 1,
  "ProductTicketFilter": 0,
  "TotalSales": 1.0,
  "TotalSalesFilter": 0,
  "IsMember": true,
  "CustomerIsNew": true,
  "ReceivedDiscount": true
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.