Public
Documentation Settings
Select option
Double Column
Select option
Magento 2 Loyalty Program REST API
Introduction
GET
Get Loyalty Program List
POST
Create/Update Loyalty Program
POST
Add Customer to Loyalty Program
GET
Get Customer's Loyalty Program Info
DEL
Delete Loyalty Program
GET
Get Customer's Loyalty Program Dashboard
POST
Customer Change Email Notify

Magento 2 Loyalty Program REST API

GETGet Loyalty Program List

{{magento_base_url}}/rest/V1/mpLoyalty/programs?searchCriteria[filter_groups][0][filters][0][field]=program_id&searchCriteria[filter_groups][0][filters][0][value]=2&searchCriteria[filter_groups][0][filters][0][condition_type]=eq

You can filter by using params SearchCriteria

HEADERS
Content-Type

application/json

Authorization

Bearer {{admin_token}}

PARAMS
searchCriteria[filter_groups][0][filters][0][field]

program_id

searchCriteria[filter_groups][0][filters][0][value]

2

searchCriteria[filter_groups][0][filters][0][condition_type]

eq

Example Request
Get Loyalty Program List Example
curl
curl --location -g '{{magento_base_url}}/rest/V1/mpLoyalty/programs?searchCriteria[filter_groups][0][filters][0][field]=program_id&searchCriteria[filter_groups][0][filters][0][value]=1&searchCriteria[filter_groups][0][filters][0][condition_type]=eq' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{admin_token}}'
200 OK
Example Response
json
{
  "items": [
    {
      "program_id": 1,
      "program_name": "Program create by api",
      "is_active": 0,
      "duration_unit": "day",
      "duration_no": 10,
      "description": "<p>test 123</p>\r\n<p><strong>Program Loy</strong></p>",
      "priority": "10",
      "updated_at": "2020-07-21 07:29:38",
      "created_at": "2020-07-21 07:28:04"
    }
  ],
  "search_criteria": {
    "filter_groups": [
      {
        "filters": [
          {
            "field": "program_id",
            "value": "1",
            "condition_type": "eq"
          }
        ]
      }
    ]
  },
  "total_count": 1
}
Date

Tue, 21 Jul 2020 07:30:26 GMT

Server

Apache/2.4.38 (Ubuntu)

Expires

Thu, 19 Nov 1981 08:52:00 GMT

Cache-Control

no-store, no-cache, must-revalidate

Pragma

no-cache

Set-Cookie

PHPSESSID=pikfuube7eubkgr5h1buq4nt13; expires=Tue, 21-Jul-2020 08:30:26 GMT; Max-Age=3600; path=/api/api2; domain=develop.mageplaza.com; HttpOnly

X-Frame-Options

SAMEORIGIN

Content-Length

405

Keep-Alive

timeout=5, max=100

Connection

Keep-Alive

Content-Type

application/json; charset=utf-8

POSTCreate/Update Loyalty Program

{{magento_base_url}}/rest/V1/mpLoyalty/programs

To update the program, please add "program_id" field in body section, see example

HEADERS
Content-Type

application/json

Authorization

Bearer {{admin_token}}

Bodyraw (json)
json
{
    "program": {
        "program_name": "Program create by api",
        "is_active": 0,
        "duration_unit": "day",
        "duration_no": 10,
        "description": "<p>Program Loyalty</p>",
        "priority": "10"
    }
}
Example Request
Update Loyalty Program
curl
curl --location -g '{{magento_base_url}}/rest/V1/mpLoyalty/programs' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{admin_token}}' \
--data '{
    "program": {
        "program_id": 1,
        "program_name": "Program create by api",
        "is_active": 0,
        "duration_unit": "day",
        "duration_no": 10,
        "description": "<p>test 123</p>\r\n<p><strong>Program Loy</strong></p>",
        "priority": "10"
    }
}'
200 OK
Example Response
json
{
  "program_id": 1,
  "program_name": "Program create by api",
  "is_active": 0,
  "duration_unit": "day",
  "duration_no": 10,
  "description": "<p>test 123</p>\r\n<p><strong>Program Loy</strong></p>",
  "priority": "10",
  "updated_at": "2020-07-21 07:29:38",
  "created_at": "2020-07-21 07:28:04"
}
Date

Tue, 21 Jul 2020 07:29:38 GMT

Server

Apache/2.4.38 (Ubuntu)

Expires

Thu, 19 Nov 1981 08:52:00 GMT

Cache-Control

no-store, no-cache, must-revalidate

Pragma

no-cache

Set-Cookie

PHPSESSID=pikfuube7eubkgr5h1buq4nt13; expires=Tue, 21-Jul-2020 08:29:38 GMT; Max-Age=3600; path=/api/api2; domain=develop.mageplaza.com; HttpOnly

X-Frame-Options

SAMEORIGIN

Content-Length

268

Keep-Alive

timeout=5, max=100

Connection

Keep-Alive

Content-Type

application/json; charset=utf-8

POSTAdd Customer to Loyalty Program

{{magento_base_url}}/rest/V1/mpLoyalty/programs/customer/add/:programId?customers=roni_cost@example.com

You can add multiple customers by filling in the customers field in Params, emails are seperated from each other by a comma ","

HEADERS
Content-Type

application/json

Authorization

Bearer {{admin_token}}

PARAMS
customers

roni_cost@example.com

PATH VARIABLES
programId

2

Example Request
Add Customer Example
curl
curl --location -g --request POST '{{magento_base_url}}/rest/V1/mpLoyalty/programs/customer/add/1?customers=roni_cost%40example.com%2Cquynhtest%40gmail.com' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{admin_token}}'
200 OK
Example Response
json
true
Date

Tue, 21 Jul 2020 07:34:57 GMT

Server

Apache/2.4.38 (Ubuntu)

Expires

Thu, 19 Nov 1981 08:52:00 GMT

Cache-Control

no-store, no-cache, must-revalidate

Pragma

no-cache

Set-Cookie

PHPSESSID=pikfuube7eubkgr5h1buq4nt13; expires=Tue, 21-Jul-2020 08:34:57 GMT; Max-Age=3600; path=/api/api2; domain=develop.mageplaza.com; HttpOnly

X-Frame-Options

SAMEORIGIN

Content-Length

4

Keep-Alive

timeout=5, max=100

Connection

Keep-Alive

Content-Type

application/json; charset=utf-8

GETGet Customer's Loyalty Program Info

{{magento_base_url}}/rest/V1/mpLoyalty/customers/

You can filter by using params SearchCriteria

HEADERS
Content-Type

application/json

Authorization

Bearer {{admin_token}}

PARAMS
searchCriteria[filter_groups][0][filters][0][field]

customer_id

searchCriteria[filter_groups][0][filters][0][value]

1

searchCriteria[filter_groups][0][filters][0][condition_type]

eq

Example Request
Get Customer Example
curl
curl --location -g '{{magento_base_url}}/rest/V1/mpLoyalty/customers/?searchCriteria[filter_groups][0][filters][0][field]=customer_id&searchCriteria[filter_groups][0][filters][0][value]=1&searchCriteria[filter_groups][0][filters][0][condition_type]=eq' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{admin_token}}'
200 OK
Example Response
json
{
  "items": [
    {
      "customer_id": 1,
      "customer_name": "Veronica Costello",
      "email": "roni_cost@example.com",
      "program_name": "Program create by api",
      "mp_program_start_at": "2020-07-21 07:38:11",
      "mp_program_manually": "1",
      "mp_program_email": 1,
      "expired_date": "Jul 31, 2020, 7:38:11 AM"
    }
  ],
  "search_criteria": {
    "filter_groups": [
      {
        "filters": [
          {
            "field": "customer_id",
            "value": "1",
            "condition_type": "eq"
          }
        ]
      }
    ]
  },
  "total_count": 1
}
Date

Tue, 21 Jul 2020 07:39:34 GMT

Server

Apache/2.4.38 (Ubuntu)

Expires

Thu, 19 Nov 1981 08:52:00 GMT

Cache-Control

no-store, no-cache, must-revalidate

Pragma

no-cache

Set-Cookie

PHPSESSID=pikfuube7eubkgr5h1buq4nt13; expires=Tue, 21-Jul-2020 08:39:34 GMT; Max-Age=3600; path=/api/api2; domain=develop.mageplaza.com; HttpOnly

X-Frame-Options

SAMEORIGIN

Content-Length

395

Keep-Alive

timeout=5, max=100

Connection

Keep-Alive

Content-Type

application/json; charset=utf-8