Public
Documentation Settings
No Environment
Double Column
cURL - cURL
Magento 2 Product Alert API & Examples
Introduction
POST
Customer Token
GET
Out-of-Stock Alert All List by Customer
GET
Product Price Alert All List by Customer
DEL
Customer Unsubscribe By ID
GET
Out-of-Stock Subcribers List
GET
Out-of-Stock Subcribers List by ID
DEL
Unsubscribe Out-of-Stock by ID
POST
Send Out-of-Stock Email by ID
POST
Cancel Out-of-Stock Subscribe by ID
POST
Create New Out-of-Stock Subscribe
GET
Out-of-Stock Products Requestes List
GET
Price Alert Subcribers List
GET
Price Alert Subcribers List by ID
DEL
Unsubscribe Price Alert by ID
POST
Create New Price Alert Subscribe
GET
Price Alert Products Requestes List
POST
Send Price Alert Email by ID
POST
Cancel Price Alert Subscribe by ID
POST
Guest Create New Price Alert Subscribe
POST
Customer Create New Price Alert Subscribe
POST
Guest Create New Out-of-Stock Subscribe
POST
Customer Create New Price Alert Subscribe
GET
Get configuration Product Alerts

Magento 2 Product Alert API & Examples

POSTCustomer Token

{{magento_base_url}}/swagger/V1/integration/customer/token
AUTHORIZATIONBearer Token
Token

<token>

HEADERS
Content-Type

application/json

Bodyraw (json)
json
{
	"username": "roni_cost@example.com",
	"password": "roni_cost3@example.com"
}
Example Request
Customer Token
curl
curl --location -g '{{magento_base_url}}rest/V1/integration/customer/token' \
--header 'Content-Type: application/json' \
--data-raw '{
	"username": "roni_cost@example.com",
	"password": "roni_cost3@example.com"
}'
200 OK
Example Response
json
"0tp6pw64p9duitd07m30git9fw72v0jk"
Date

Thu, 27 Feb 2020 06:48:00 GMT

Server

Apache/2.4.38 (Ubuntu)

Set-Cookie

PHPSESSID=cola5virj65d63gk00gqgf1kre; expires=Thu, 27-Feb-2020 07:48:00 GMT; Max-Age=3600; path=/hang/ce234; domain=192.168.1.200; HttpOnly

Set-Cookie

persistent_shopping_cart=deleted; expires=Thu, 01-Jan-1970 00:00:01 GMT; Max-Age=0; path=/hang/ce234; HttpOnly

Set-Cookie

form_key=deleted; expires=Thu, 01-Jan-1970 00:00:01 GMT; Max-Age=0; path=/hang/ce234; domain=192.168.1.200

Expires

Thu, 19 Nov 1981 08:52:00 GMT

Cache-Control

no-store, no-cache, must-revalidate

Pragma

no-cache

X-Frame-Options

SAMEORIGIN

Content-Length

34

Keep-Alive

timeout=5, max=100

Connection

Keep-Alive

Content-Type

application/json; charset=utf-8

GETOut-of-Stock Alert All List by Customer

{{magento_base_url}}rest/V1/mpProductAlert/mine/out-of-stock
HEADERS
Content-Type

application/json

Authorization

Bearer {{customer_token}}

PARAMS
searchCriteria
searchCriteria[pageSize]
searchCriteria[currentPage]
searchCriteria[filter_groups][0][filters][0][field]
searchCriteria[filter_groups][0][filters][0][value]
searchCriteria[filter_groups][0][filters][0][condition_type]
Example Request
Out-of-Stock Alert All List by Customer
curl
curl --location -g '{{magento_base_url}}rest/V1/mpProductAlert/mine/out-of-stock' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{customer_token}}'
200 OK
Example Response
json
[
  {
    "subscriber_id": 4,
    "customer_id": 1,
    "customer_email": "roni_cost@example.com",
    "product_id": 2046,
    "customer_group": "1",
    "status": 2,
    "type": 1,
    "old_price": 0,
    "store_id": 0,
    "website_id": 1,
    "send_count": 3,
    "subscribe_updated_at": "2020-02-27 07:29:19",
    "subscribe_created_at": "2020-02-27 07:29:19",
    "last_send_date": null
  },
  {
    "subscriber_id": 28,
    "customer_id": 1,
    "customer_email": "roni_cost@example.com",
    "product_id": 2,
    "customer_group": "1",
    "status": 2,
    "type": 1,
    "old_price": 32,
    "store_id": 0,
    "website_id": 1,
    "send_count": 0,
    "subscribe_updated_at": "2020-03-04 02:50:21",
    "subscribe_created_at": "2020-03-04 02:50:21",
    "last_send_date": null
  }
]
Date

Wed, 04 Mar 2020 04:19:16 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=m45rvjqtqauvf2bdbe3bicdbtr; expires=Wed, 04-Mar-2020 05:19:16 GMT; Max-Age=3600; path=/hang/ce234; domain=192.168.1.200; HttpOnly

X-Frame-Options

SAMEORIGIN

Content-Length

610

Keep-Alive

timeout=5, max=100

Connection

Keep-Alive

Content-Type

application/json; charset=utf-8

GETProduct Price Alert All List by Customer

{{magento_base_url}}rest/V1/mpProductAlert/mine/product-price
HEADERS
Content-Type

application/json

Authorization

Bearer {{customer_token}}

PARAMS
searchCriteria
searchCriteria[pageSize]
searchCriteria[currentPage]
searchCriteria[filter_groups][0][filters][0][field]
searchCriteria[filter_groups][0][filters][0][value]
searchCriteria[filter_groups][0][filters][0][condition_type]
Example Request
Product Price Alert All List by Customer
curl
curl --location -g '{{magento_base_url}}rest/V1/mpProductAlert/mine/product-price' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{customer_token}}'
200 OK
Example Response
json
[
  {
    "subscriber_id": 3,
    "customer_id": 1,
    "customer_email": "roni_cost@example.com",
    "product_id": 2046,
    "customer_group": "1",
    "status": 2,
    "type": 2,
    "old_price": 0,
    "store_id": 0,
    "website_id": 1,
    "send_count": 3,
    "subscribe_updated_at": "2020-02-27 07:29:12",
    "subscribe_created_at": "2020-02-27 07:29:12",
    "last_send_date": null
  },
  {
    "subscriber_id": 24,
    "customer_id": 1,
    "customer_email": "roni_cost@example.com",
    "product_id": 1,
    "customer_group": "1",
    "status": 2,
    "type": 2,
    "old_price": 13,
    "store_id": 1,
    "website_id": 1,
    "send_count": 0,
    "subscribe_updated_at": "2020-03-04 02:18:58",
    "subscribe_created_at": "2020-03-04 02:18:58",
    "last_send_date": null
  },
  {
    "subscriber_id": 26,
    "customer_id": 1,
    "customer_email": "roni_cost@example.com",
    "product_id": 2,
    "customer_group": "1",
    "status": 2,
    "type": 2,
    "old_price": 32,
    "store_id": 0,
    "website_id": 1,
    "send_count": 0,
    "subscribe_updated_at": "2020-03-04 02:33:49",
    "subscribe_created_at": "2020-03-04 02:33:49",
    "last_send_date": null
  }
]
Date

Wed, 04 Mar 2020 04:21:18 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=m45rvjqtqauvf2bdbe3bicdbtr; expires=Wed, 04-Mar-2020 05:21:18 GMT; Max-Age=3600; path=/hang/ce234; domain=192.168.1.200; HttpOnly

X-Frame-Options

SAMEORIGIN

Content-Length

914

Keep-Alive

timeout=5, max=100

Connection

Keep-Alive

Content-Type

application/json; charset=utf-8

DELETECustomer Unsubscribe By ID

{{magento_base_url}}rest/V1/mpProductAlert/mine/subscriber/delete/:subscriber_id
HEADERS
Content-Type

application/json

Authorization

Bearer {{customer_token}}

PATH VARIABLES
subscriber_id
Example Request
Unsubscribe By ID
curl
curl --location -g --request DELETE '{{magento_base_url}}rest/V1/mpProductAlert/mine/subscriber/delete/28' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{customer_token}}'
200 OK
Example Response
json
true
Date

Wed, 04 Mar 2020 04:22:11 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=m45rvjqtqauvf2bdbe3bicdbtr; expires=Wed, 04-Mar-2020 05:22:12 GMT; Max-Age=3600; path=/hang/ce234; domain=192.168.1.200; HttpOnly

X-Frame-Options

SAMEORIGIN

Content-Length

4

Keep-Alive

timeout=5, max=100

Connection

Keep-Alive

Content-Type

application/json; charset=utf-8