Needio.Services

<back to all web services

GetSaleDashboardStatisticsRequest

Requires Authentication
Required role:Approved
The following routes are available for this service:
All Verbs/User/GetSaleDashboardStatistics/
GetSaleDashboardStatisticsRequest Parameters:
NameParameterData TypeRequiredDescription
StoreIdqueryintNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
GetSaleDashboardStatisticsResponse Parameters:
NameParameterData TypeRequiredDescription
SaleDashboardDTOformSaleDashboardDTONo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
SaleDashboardDTO Parameters:
NameParameterData TypeRequiredDescription
NewOrdersCountformintNo
ApprovedOrdersCountformintNo
ShippedOrdersCountformintNo
RejectOrdersCountformintNo
ReturnOrdersCountformintNo
ChatCountformintNo
CancelOrdersCountformintNo
GetSaleDashboardStatisticsResponse Parameters:
NameParameterData TypeRequiredDescription
SaleDashboardDTOformSaleDashboardDTONo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /User/GetSaleDashboardStatistics/ HTTP/1.1 
Host: baseservices.needion.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	StoreId: 0,
	start: 2021-10-25T14:09:12.0605038+03:00,
	DeviceUUID: String,
	APIKey: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	SaleDashboardDTO: 
	{
		NewOrdersCount: 0,
		ApprovedOrdersCount: 0,
		ShippedOrdersCount: 0,
		RejectOrdersCount: 0,
		ReturnOrdersCount: 0,
		ChatCount: 0,
		CancelOrdersCount: 0
	},
	Result: False,
	ResMessage: String,
	Error: 
	{
		ErrorYn: False,
		ErrorCode: String,
		ErrorDescription: String
	},
	PageInfo: 
	{
		TotalRecordCount: 0,
		TotalPageCount: 0,
		CurrentPage: 0
	}
}