Points transfers

These endpoints will allow you to easily manage Points transfers.

Get a complete list of Points transfers

To retrieve a paginated list of Points transfers, you need to call the /api/<storeCode>/points/transfer endpoint with the GET method.

Definition

GET  /api/<storeCode>/points/transfer
Parameter Parameter type Description
Authorization header Token received during authentication
<storeCode> query Code of the store to get points transfers from.
customerFirstName query (optional) First Name
customerLastName query (optional) Last Name
customerPhone query (optional) Customer Phone
customerEmail query (optional) Customer Email
customerId query (optional) Customer ID
state[] query (optional) Possible values: active, expired
type query (optional) Possible values: adding, spending, p2p_adding, p2p_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
direction query (optional) Direction of sorting [ASC, DESC], by default = ASC

Example

curl http://localhost:8181/api/DEFAULT/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.

Example Response

STATUS: 200 OK
{
    "transfers": [
        {
            "pointsTransferId": "ae1c49b1-02ab-4626-982d-71b544b01136",
            "accountId": "49a218ab-71ba-4f7f-8f4e-407df5f84b11",
            "customerId": "00000000-0000-474c-b092-b0dd880c07e1",
            "customerFirstName": "John",
            "customerLastName": "Doe",
            "customerLoyaltyCardNumber": "47834433524",
            "customerEmail": "user@example.com",
            "customerPhone": "+48234234000",
            "createdAt": "2018-09-13T16:37:33+0200",
            "expiresAt": "2018-10-13T16:37:33+0200",
            "value": 10,
            "state": "active",
            "type": "adding",
            "comment": "Event - First Purchase - 10",
            "issuer": "system"
        },
        {
            "pointsTransferId": "cd470d77-a08e-4c62-9f47-da180524f683",
            "accountId": "49a218ab-71ba-4f7f-8f4e-407df5f84b11",
            "customerId": "00000000-0000-474c-b092-b0dd880c07e1",
            "customerFirstName": "John",
            "customerLastName": "Doe",
            "customerLoyaltyCardNumber": "47834433524",
            "customerEmail": "user@example.com",
            "customerPhone": "+48234234000",
            "createdAt": "2018-09-13T16:37:33+0200",
            "expiresAt": "2018-10-13T16:37:33+0200",
            "value": 6.9,
            "state": "active",
            "type": "adding",
            "transactionId": {
                "transactionId": "00000000-0000-1111-0000-000000000003"
            },
            "comment": "General spending rule - 2.3",
            "issuer": "system",
            "transactionDocumentNumber": "456",
            "transaction": {
                "grossValue": 3,
                "labels": [
                    {
                        "key": "first label",
                        "value": "first test"
                    },
                    {
                        "key": "second label",
                        "value": "second test"
                    }
                ],
                "items": [
                    {
                        "sku": {
                            "code": "SKU1"
                        },
                        "name": "item 1",
                        "quantity": 1,
                        "grossValue": 1,
                        "category": "aaa",
                        "labels": [
                            {
                                "key": "test",
                                "value": "label"
                            },
                            {
                                "key": "test",
                                "value": "label2"
                            }
                        ],
                        "maker": "sss"
                    },
                    {
                        "sku": {
                            "code": "SKU2"
                        },
                        "name": "item 2",
                        "quantity": 2,
                        "grossValue": 2,
                        "category": "bbb",
                        "labels": [],
                        "maker": "ccc"
                    }
                ]
            }
        }
    ],
    "total": 2
}

Get a complete list of points transfers (customer)

To retrieve a paginated list of Points transfers, you need to call the /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 (optional) Possible values: active, expired, pending
type query (optional) Possible values: adding, 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
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.

Example Response

STATUS: 200 OK
{
    "transfers": [
        {
            "pointsTransferId": "ae1c49b1-02ab-4626-982d-71b544b01136",
            "accountId": "49a218ab-71ba-4f7f-8f4e-407df5f84b11",
            "customerId": "00000000-0000-474c-b092-b0dd880c07e1",
            "customerFirstName": "John",
            "customerLastName": "Doe",
            "customerLoyaltyCardNumber": "47834433524",
            "customerEmail": "user@example.com",
            "customerPhone": "+48234234000",
            "createdAt": "2018-09-13T16:37:33+0200",
            "expiresAt": "2018-10-13T16:37:33+0200",
            "value": 10,
            "state": "active",
            "type": "adding",
            "comment": "Event - First Purchase - 10",
            "issuer": "system"
        },
        {
            "pointsTransferId": "cd470d77-a08e-4c62-9f47-da180524f683",
            "accountId": "49a218ab-71ba-4f7f-8f4e-407df5f84b11",
            "customerId": "00000000-0000-474c-b092-b0dd880c07e1",
            "customerFirstName": "John",
            "customerLastName": "Doe",
            "customerLoyaltyCardNumber": "47834433524",
            "customerEmail": "user@example.com",
            "customerPhone": "+48234234000",
            "createdAt": "2018-09-13T16:37:33+0200",
            "expiresAt": "2018-10-13T16:37:33+0200",
            "value": 6.9,
            "state": "active",
            "type": "adding",
            "transactionId": {
                "transactionId": "00000000-0000-1111-0000-000000000003"
            },
            "comment": "General spending rule - 2.3",
            "issuer": "system",
            "transactionDocumentNumber": "456",
            "transaction": {
                "grossValue": 3,
                "labels": [
                    {
                        "key": "first label",
                        "value": "first test"
                    },
                    {
                        "key": "second label",
                        "value": "second test"
                    }
                ],
                "items": [
                    {
                        "sku": {
                            "code": "SKU1"
                        },
                        "name": "item 1",
                        "quantity": 1,
                        "grossValue": 1,
                        "category": "aaa",
                        "labels": [
                            {
                                "key": "test",
                                "value": "label"
                            },
                            {
                                "key": "test",
                                "value": "label2"
                            }
                        ],
                        "maker": "sss"
                    },
                    {
                        "sku": {
                            "code": "SKU2"
                        },
                        "name": "item 2",
                        "quantity": 2,
                        "grossValue": 2,
                        "category": "bbb",
                        "labels": [],
                        "maker": "ccc"
                    }
                ]
            }
        }
    ],
    "total": 2
}

Add points to customer’s account

To add points, you need to call the /api/<storeCode>/points/transfer/add endpoint with the POST method.

Definition

POST /api/<storeCode>/points/transfer/add
Parameter Parameter type Description
Authorization header Token received during authentication
<storeCode> query Code of the store the customer belongs to.
transfer[customer] query Customer ID
transfer[points] query How many points customer can get
transfer[comment] query (optional) Comment

Example

curl http://localhost:8181/api/DEFAULT/points/transfer/add \
    -X "POST" \
    -H "Accept: application/json" \
    -H "Content-type: application/x-www-form-urlencoded" \
    -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6..." \
    -d "transfer[customer]=b9af6a8c-9cc5-4924-989c-e4af614ab2a3" \
    -d "transfer[points]=9"

Note

The eyJhbGciOiJSUzI1NiIsInR5cCI6… authorization token is an example value. Your value may be different. Read more about Authorization here.

Example Response

STATUS: 200 OK
{
  "pointsTransferId": "32132863-3d1e-4a94-8bb4-6e42e3c96c0b"
}

Spend customer’s points

To spend a customer’s points, you need to call the /api/<storeCode>/points/transfer/spend endpoint with the POST method.

Definition

POST /api/<storeCode>/points/transfer/spend
Parameter Parameter type Description
Authorization header Token received during authentication
<storeCode> query Code of the store the customer belongs to.
transfer[customer] query Customer ID
transfer[points] query How many points customer can spend
transfer[comment] query (optional) Comment

Example

curl http://localhost:8181/api/DEFAULT/points/transfer/spend \
    -X "POST" \
    -H "Accept: application/json" \
    -H "Content-type: application/x-www-form-urlencoded" \
    -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6..." \
    -d "transfer[customer]=b9af6a8c-9cc5-4924-989c-e4af614ab2a3" \
    -d "transfer[points]=1"

Note

The eyJhbGciOiJSUzI1NiIsInR5cCI6… authorization token is an example value. Your value may be different. Read more about Authorization here.

Example Response

STATUS: 200 OK
{
  "pointsTransferId": "b97a31fe-9bc9-4fff-a467-487f2c316371"
}

Transfer points between customers (admin)

To transfer points between customers, you need to call the /api/<storeCode>/admin/p2p-points-transfer endpoint with the POST method.

Definition

POST /api/<storeCode>/admin/p2p-points-transfer
Parameter Parameter type Description
Authorization header Token received during authentication
<storeCode> query Code of the store both customers belong to.
transfer[sender] query email/phone or uuid of customer from whom points will be transferred
transfer[receiver] query email/phone or uuid of customer who will get points
transfer[points] query How many points will be transferred

Example

curl http://localhost:8181/api/DEFAULT/admin/p2p-points-transfer \
    -X "POST" \
    -H "Accept: application/json" \
    -H "Content-type: application/x-www-form-urlencoded" \
    -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6..." \
    -d "transfer[sender]=b9af6a8c-9cc5-4924-989c-e4af614ab2a3" \
    -d "transfer[receiver]=b9af6a8c-9cc5-4924-989c-e4af614ab3c5" \
    -d "transfer[points]=100"

Note

The eyJhbGciOiJSUzI1NiIsInR5cCI6… authorization token is an example value. Your value may be different. Read more about Authorization here.

Example Response

STATUS: 200 OK
{
  "pointsTransferId": "b97a31fe-9bc9-4fff-a467-487f2c316371"
}

Note

Returned pointsTransferId is a UUID of the P2P spend points transfer created.

Transfer points between customers (customer)

To transfer points between a logged-in customer and another customer, you need to call 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 both customers belong to.
transfer[receiver] query email/phone or uuid of customer who will get points
transfer[points] query How many points will be transferred

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]=b9af6a8c-9cc5-4924-989c-e4af614ab3c5" \
    -d "transfer[points]=100"

Note

The eyJhbGciOiJSUzI1NiIsInR5cCI6… authorization token is an example value. Your value may be different. Read more about Authorization here.

Example Response

STATUS: 200 OK
{
  "pointsTransferId": "b97a31fe-9bc9-4fff-a467-487f2c316371"
}

Note

Returned pointsTransferId is a UUID of the P2P spend points transfer created.

Cancel specific points transfer

To cancel a specific points transfer, you need to call the /api/<storeCode>/points/transfer/<transfer>/cancel endpoint with the POST method.

Definition

POST /api/<storeCode>/points/transfer/<transfer>/cancel
Parameter Parameter type Description
Authorization header Token received during authentication
<storeCode> query Code of the store the point transfer was made in.
<transfer> query Points transfer ID

Example

curl http://localhost:8181/api/DEFAULT/points/transfer/313cf0c1-5376-4f66-9de3-77943760423a/cancel \
    -X "POST" \
    -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.

Example Response

STATUS: 200 OK
(no content)

Activate specific points transfer

To activate a specific points transfer, you need to call the /api/<storeCode>/points/transfer/<transfer>/activate endpoint with the POST method.

Requirements:
  • transfer MUST HAVE state PENDING;
Results:
  • transfer will have state ACTIVE and points will be unlocked;

Definition

POST /api/<storeCode>/points/transfer/<transfer>/activate
Parameter Parameter type Description
Authorization header Token received during authentication
<storeCode> query Code of the store the point transfer was made in.
<transfer> query Points transfer ID

Example

curl http://localhost:8181/api/DEFAULT/points/transfer/313cf0c1-5376-4f66-9de3-77943760423a/activate \
    -X "POST" \
    -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.

Example Response

STATUS: 204 No Content
(no content)

Expire specific points transfer

To expire a specific points transfer, you need to call the /api/<storeCode>/points/transfer/<transfer>/expire endpoint with the POST method.

Requirements:
  • transfer MUST HAVE state ACTIVE;
Results:
  • transfer will have state EXPIRED and current date in expiredAt;

Definition

POST /api/<storeCode>/points/transfer/<transfer>/expire
Parameter Parameter type Description
Authorization header Token received during authentication
<storeCode> query Code of the store the point transfer was made in.
<transfer> query Points transfer ID

Example

curl http://localhost:8181/api/DEFAULT/points/transfer/313cf0c1-5376-4f66-9de3-77943760423a/expire \
    -X "POST" \
    -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.

Example Response

STATUS: 204 No Content
(no content)

Import point transfers

To import a file with points transfers, you need to call the /api/<storeCode>/points/transfer/import endpoint with the POST method.

Definition

POST /api/<storeCode>/points/transfer/import
Parameter Parameter type Description
Authorization header Token received during authentication
<storeCode> query Code of the store the transfers will be made in.
file[file] query XML file

Example

curl http://localhost:8181/api/DEFAULT/points/transfer/import \
    -X "POST" \
    -H "Accept: application/json" \
    -H "Content-type: application/x-www-form-urlencoded" \
    -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6..." \
    -d "file[file]=C:\\fakepath\\points.xml"

Note

The eyJhbGciOiJSUzI1NiIsInR5cCI6… authorization token is an example value. Your value may be different. Read more about Authorization here.

Example Response

STATUS: 200 OK
{
  "items": [
    {
      "status": "success",
      "processImportResult": {
        "object": {
          "pointsTransferId": "e08cf828-989b-4bd0-8221-cf44c3be8a64"
        }
      },
      "identifier": "11000000-0000-474c-b092-b0dd880c07e2x/(adding 15)"
    }
  ],
  "totalProcessed": 1,
  "totalSuccess": 1,
  "totalFailed": 0
}

Points transfers histogram

To get information about points transfers histogram, you need to call the /api/<storeCode>/points/transfers endpoint with the GET method.

Definition

GET /api/<storeCode>/points/transfers
Parameter Parameter type Description
Authorization header Token received during authentication
<storeCode> request Filter result by given store
<interval> request Group result by (day|month|year)
<lastDays> request Display data in last days
<futureDays> request Display data to X future days
<pointType> request Type of point (earned, spent, expired, pending)

Example

curl http://localhost:8181/api/DEFAULT/points/transfers \
    -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.

Example Response

STATUS: 200 OK
{
  "2018-01-06": 0,
  "2018-01-07": 0,
  "2018-01-08": 0,
  "2018-01-09": 5,
  "2018-01-10": 0,
  "2018-01-11": 5,
  "2018-01-12": 4,
  "2018-01-13": 3,
  "2018-01-14": 0,
  "2018-01-15": 0,
  "2018-01-16": 3,
  "2018-01-17": 0,
  "2018-01-18": 5,
  "2018-01-19": 0,
  "2018-01-20": 6,
  "2018-01-21": 5,
  "2018-01-22": 0,
  "2018-01-23": 6,
  "2018-01-24": 0,
  "2018-01-25": 0,
  "2018-01-26": 0,
  "2018-01-27": 0,
  "2018-01-28": 5,
  "2018-01-29": 0,
  "2018-01-30": 0,
  "2018-01-31": 0,
  "2018-02-01": 0,
  "2018-02-02": 5,
  "2018-02-03": 0,
  "2018-02-04": 0
}

Block points on customer’s account

The administrator can block points on a customer’s account in order to prevent them from spending them. To block points, you need to call the /api/<storeCode>/points/transfer/block endpoint with the POST method. In order to unblock points, you need to use the /api/<storeCode>/points/transfer/<transfer>/cancel endpoint.

Definition

POST /api/<storeCode>/points/transfer/block
Parameter Parameter type Description
Authorization header Token received during authentication
<storeCode> query Code of the store the customer belongs to.
transfer[customer] query Customer ID
transfer[points] query How many points to block
transfer[comment] query (optional) Comment

Example

curl http://localhost:8181/api/DEFAULT/points/transfer/block \
    -X "POST" \
    -H "Accept: application/json" \
    -H "Content-type: application/x-www-form-urlencoded" \
    -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6..." \
    -d "transfer[customer]=b9af6a8c-9cc5-4924-989c-e4af614ab2a3" \
    -d "transfer[points]=9"

Note

The eyJhbGciOiJSUzI1NiIsInR5cCI6… authorization token is an example value. Your value may be different. Read more about Authorization here.

Example Response

STATUS: 200 OK
{
  "pointsTransferId": "32132863-3d1e-4a94-8bb4-6e42e3c96c0b"
}