Wallet

Actions

Action method for resource wallet.

HTTP method Endpoint Description
[badge-blue GET] /wallet/actions/sales-turnover Sales turnover of the customer in time interval
[badge-blue GET] /wallet/actions/points-overview Points overview of the customer in time interval
[badge-blue GET] /wallet/actions/credits-overview Credits overview of the customer in time interval
[badge-blue GET] /wallet/actions/points-expiration-overview Points expiration overview of the customer
[badge-blue GET] /wallet/actions/credits-expiration-overview Credits expiration overview of the customer


Get sales turnover

Get information about sales turnover of the customer in time interval
[badge-blue GET] /wallet/actions/sales-turnover

Request

Parameter name Type Description Mandatory (Yes/No)
customer_id string The unique id of the customer Yes
date_from string Date (ISO 8601) start of the time interval
YYYY-MM-DD		 No
date_to string Date (ISO 8601) end of the time interval
YYYY-MM-DD		 No

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
turnover QualificationTurnover[] List of all turnover by currency in time interval


Get points overview

Get information about points overview of the customer in time interval
[badge-blue GET] /wallet/actions/points-overview

Request

Parameter name Type Description Mandatory (Yes/No)
customer_id string The unique id of the customer Yes
date_from string Date (ISO 8601) start of the time interval
YYYY-MM-DD		 No
date_to string Date (ISO 8601) end of the time interval
YYYY-MM-DD		 No

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
earned_points float Amount of earned points in time interval
redeemed_points float Amount of redeemed points in time interval
available_points float Amount of available points in the moment. Time interval has no influence to the result


Get credits overview

Get information about credits overview of the customer in the time interval
[badge-blue GET] /wallet/actions/credits-overview

Request

Parameter name Type Description Mandatory (Yes/No)
customer_id string The unique id of the customer Yes
date_from string Date (ISO 8601) start of the time interval
YYYY-MM-DD		 No
date_to string Date (ISO 8601) end of the time interval
YYYY-MM-DD		 No

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
earned_credits float Amount of earned credits in the time interval
redeemed_credits float Amount of redeemed credits in the time interval
available_credits float Amount of available credits in the moment. Time interval has no influence to the result


Get points expiration overview

Get information about points expiration overview of the customer
[badge-blue GET] /wallet/actions/points-expiration-overview

Request

Parameter name Type Description Mandatory (Yes/No)
customer_id string The unique id of the customer Yes

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
next_amount float Amount of points, that will expire first
next_date string Date (ISO 8601) when first points will expire
YYYY-MM-DD
current_month_amount float Amount of points that will expire in current month


Get credits expiration overview

Get information about credits expiration overview of the customer
[badge-blue GET] /wallet/actions/credits-expiration-overview

Request

Parameter name Type Description Mandatory (Yes/No)
customer_id string The unique id of the customer Yes

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
next_amount float Amount of credits, that will expire first
next_date string Date (ISO 8601) when first credits will expire
YYYY-MM-DD
current_month_amount float Amount of credits that will expire in current month