SEARCH api/v1/Points/ForStores?type={type}&from={from}&to={to}
Retrieve array of points within the datetime from(including) and to with specified type and associated with one of stores in the list.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
type |
Type of points to retrieve |
string |
Required |
from |
The from datetime (including) - Datetimeoffset |
date |
Required |
to |
The to datetime - Datetimeoffset |
date |
Required |
Body Parameters
List of storeIds
Collection of integerRequest Formats
application/json, text/json
[ 1, 2 ]
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
Points of the specified type created within the period and associated with one of stores in the list.
Collection of ReadPointDtoName | Description | Type | Additional information |
---|---|---|---|
Id |
Unique id of the point |
integer |
None. |
ContactId |
Id of contact |
integer |
None. |
ContactCompanyId |
Id of ContactCompany. Applies only if the contact is associated with a company. |
integer |
None. |
Type |
Type of point |
string |
Max length: 32 |
Amount |
Amount of point |
decimal number |
None. |
Sum |
The sum of all the points with the same contact id and type when the point was created |
decimal number |
None. |
DateTime |
Creation datetime of the point |
date |
None. |
Description |
Description of point |
string |
None. |
SourceId |
Id of source |
string |
Max length: 255 |
SourceDescription |
Description of source |
string |
None. |
StoreId |
Id of store for the point |
integer |
None. |
AdministratorId |
Id of administrator who created the point |
integer |
None. |
BookValue |
Value of the point for bookkeeping |
decimal number |
None. |
SubType |
SubType of point |
string |
Max length: 32 |
PointCalculationBase |
The original value the point value was calculated from |
decimal number |
None. |
ConverterTransactionId |
The transaction id of a converter |
integer |
None. |
IsCanceller |
Idicates if this point is a canceller point |
boolean |
None. |
CancellerPointId |
An id of the point that cancelled this point |
integer |
None. |
Response Formats
application/json, text/json
[ { "Id": 1, "ContactId": 1, "ContactCompanyId": 1, "Type": "sample string 2", "Amount": 3.0, "Sum": 4.0, "DateTime": "2024-11-21T06:23:26.7387069+00:00", "Description": "sample string 6", "SourceId": "sample string 7", "SourceDescription": "sample string 8", "StoreId": 1, "AdministratorId": 1, "BookValue": 1.0, "SubType": "sample string 9", "PointCalculationBase": 1.0, "ConverterTransactionId": 1, "IsCanceller": true, "CancellerPointId": 1 }, { "Id": 1, "ContactId": 1, "ContactCompanyId": 1, "Type": "sample string 2", "Amount": 3.0, "Sum": 4.0, "DateTime": "2024-11-21T06:23:26.7387069+00:00", "Description": "sample string 6", "SourceId": "sample string 7", "SourceDescription": "sample string 8", "StoreId": 1, "AdministratorId": 1, "BookValue": 1.0, "SubType": "sample string 9", "PointCalculationBase": 1.0, "ConverterTransactionId": 1, "IsCanceller": true, "CancellerPointId": 1 } ]