Customer Points transfers¶
These endpoints will allow you to see Customer Points transfers list.
List of all logged-in customer points transfer¶
To retrieve a list of points transfer by a specific customer, use /api/<storeCode>/customer/points/transfer
endpoint with the GET
method.
Definition¶
GET /api/<storeCode>/customer/points/transfer
Parameter | Parameter type | Description |
---|---|---|
Authorization | header | Token received during authentication |
<storeCode> | query | Code of the store the customer belongs to. |
state | query | Set 1 if always active, otherwise 0 |
type | query | Current points status: adding or spending |
page | query | (optional) Start from page, by default 1 |
perPage | query | (optional) Number of items to display per page, by default = 10 |
sort | query | (optional) Sort by column name, by default = firstName |
direction | query | (optional) Direction of sorting [ASC, DESC], by default = ASC |
Example¶
curl http://localhost:8181/api/DEFAULT/customer/points/transfer \
-X "GET" \
-H "Accept:application/json" \
-H "Content-type: application/x-www-form-urlencoded" \
-H "Authorization:\ Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6..."
Note
The eyJhbGciOiJSUzI1NiIsInR5cCI6… authorization token is an example value. Your value may be different. Read more about Authorization here.
Attention
Pagination limitation, we can only show 10,000 results. 10,000 is a limit and can be found in the .env file.
Example Response¶
STATUS: 200 OK
{
"transfers": [
{
"pointsTransferId": "e82c96cf-32a3-43bd-9034-4df343e5f211",
"accountId": "adbdb586-317b-4bed-8cc0-346199064d45",
"customerId": "00000000-0000-474c-b092-b0dd880c07e1",
"customerFirstName": "John",
"customerLastName": "Doe",
"customerEmail": "user@example.com",
"customerPhone": "11111",
"createdAt": "2018-01-21T09:45:05+0100",
"value": 100,
"state": "active",
"type": "adding",
"issuer": "system",
"expireAt": "2018-02-20T09:45:05+0100"
},
{
"pointsTransferId": "44b4a504-d62e-49c2-8e35-7d8a19d2642e",
"accountId": "adbdb586-317b-4bed-8cc0-346199064d45",
"customerId": "00000000-0000-474c-b092-b0dd880c07e1",
"customerFirstName": "John",
"customerLastName": "Doe",
"customerEmail": "user@example.com",
"customerPhone": "11111",
"createdAt": "2018-02-19T09:45:05+0100",
"value": 6.9,
"state": "active",
"type": "adding",
"transactionId": {
"transactionId": "00000000-0000-1111-0000-000000000003"
},
"issuer": "system",
"expireAt": "2018-03-21T09:45:05+0100",
"transactionDocumentNumber": "456"
}
],
"total": 2
}
Transfer points between customers¶
To transfer points owned by a specific customer to another customer, use the /api/<storeCode>/customer/points/p2p-transfer
endpoint with the POST
method.
Definition¶
POST /api/<storeCode>/customer/points/p2p-transfer
Parameter | Parameter type | Description |
---|---|---|
Authorization | header | Token received during authentication |
<storeCode> | query | Code of the store the customers belong to. |
transfer[receiver] | string | Customer ID |
transfer[points] | float | Number of point |
Example¶
curl http://localhost:8181/api/DEFAULT/customer/points/p2p-transfer \
-X "POST" \
-H "Accept:application/json" \
-H "Content-type: application/x-www-form-urlencoded" \
-H "Authorization:\ Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6..." \
-d "transfer[receiver]=00000000-0000-474c-b092-b0dd880c07f5" \
-d "transfer[points]=11"
Note
The eyJhbGciOiJSUzI1NiIsInR5cCI6… authorization token is an example value. Your value may be different. Read more about Authorization here.