Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Basic Details
Parameters used in all requests are described here.
Subscribe to the "Back in Stock" trigger
Method Objective
The method subscribes the user to the notifications that the product is available.
Request
| Endpoint | Request Type | Content-Type |
|---|---|---|
| https://api.personaclick.com/subscriptions/subscribe_for_product_available | POST | application/json |
Parameters
| Name | Type | Requirement | Description |
|---|---|---|---|
| shop_id | string | required | Unique Store Key in PersonaClick. Located there: Account > Settings > Store Settings |
| did | string | required |
Unique Device ID. See "Initialization (REST API)" for information about getting and using Device ID.
| |||
| item_id | string/number | required | Product ID |
| string | optionally | User Email. Will be added (updated) to the user's profile is used in the request. | |
| properties[fashion_size] | string | optionally | It allows specifying the size as an additional property of the product in the subscription. See the example below. |
API Response Code
HTTP status code | Description |
|---|---|
| 200 OK | The request was successful. |
| 400 Bad Request | See the "message" property of the API response for details. |
| 403 Forbidden | See the "message" property of the API response for details. |
Example of use
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl 'https://api.personaclick.com/subscriptions/subscribe_for_product_available' \
-X 'POST' \
-H 'content-type: application/json' \
-d '{"shop_id":"0d42fd8b713d0752776ca589cc0056","did":"vxlwRZ7Cnk","item_id":"100500","email":"john.doe@examplemail.com","properties[fashion_size]":"XL"}' |
Unsubscribe from the "Back in Stock" trigger
Method Objective
The method unsubscribes the user from the notification that the product is available.
Request
| Endpoint | Request Type | Content-Type |
|---|---|---|
| https://api.personaclick.com/subscriptions/unsubscribe_from_product_available | POST | application/json |
Parameters
| Name | Type | Requirement | Description |
|---|---|---|---|
| shop_id | string | required | Unique Store |
| Key in PersonaClick. Located there: Account > Settings > Store Settings | |||||
| did | string | required | Unique Device ID. See "Initialization (REST API)" for information about getting and using Device ID.
| ||
| item_ids | string | required | Product IDs, separated by commas. Can have an empty value to remove subscriptions for all products. | ||
| string | required | User Email |
API Response Code
HTTP status code | Description |
|---|---|
| 200 OK | The request was successful. |
| 400 Bad Request | See the "message" property of the API response for details. |
| 403 Forbidden | See the "message" property of the API response for details. |
Examples of use
| Code Block | ||||
|---|---|---|---|---|
| ||||
# unsubscribe from notifications for selected products
curl 'https://api.personaclick.com/subscriptions/unsubscribe_from_product_available' \
-X 'POST' \
-H 'content-type: application/json' \
-d '{"item_ids":"PRODUCT_ID1,PRODUCT_ID2","email":"john.doe@examplemail.com","shop_id":"0d42fd8b713d0752776ca589cc0056&did=vxlwRZ7Cnk"}'
# cancel notifications for all products
curl 'https://api.personaclick.com/subscriptions/unsubscribe_from_product_available' \
-X 'POST' \
-H 'content-type: application/json' \
-d '{"item_ids":"","email":"john.doe@examplemail.com","shop_id":"0d42fd8b713d0752776ca589cc0056&did=vxlwRZ7Cnk"}' |
Checking the "Back in Stock" trigger subscription
Method Objective
The method allows checking the subscription status of the "Back in Stock" trigger.
Request
| Endpoint | Request Type |
|---|---|
| https://api.personaclick.com/products/check_product_available_subscription | GET |
Parameters
| Note |
|---|
Only parameters related to the profile update request are listed here. See "Basic Details" above for more information on required parameters and the API endpoint. |
| Name | Type | Requirement | Description |
|---|---|---|---|
| shop_id | string | required | Unique Store Key in PersonaClick. Located there: Account > Settings > Store Settings |
| shop_secret | string | required | Store Secret Key in PersonaClick. Located there: Account > Settings > Store Settings |
| item_id | string/number | required | Product ID |
| string | One of the available ones is required | Email for subscription checking | |
| phone | string | Phone for subscription checking | |
| loyalty_id | string | Loyalty ID for subscription checking |
API response properties
| Name | Type | Description |
|---|---|---|
| status | boolean | Shows whether or not there is a trigger subscription for the product |
Example of use
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl 'https://api.personaclick.com/products/check_product_available_subscription?email=john.doe%40examplemail.com&shop_id=0d42fd8b713d0752776ca589cc0056&shop_secret=0123456789abcdef0123456789abcdef&item_id=100500' |
Subscribe to the "Price Drop" trigger
Method Objective
The method subscribes the user to the notifications of a product price decrease.
Request
| Endpoint | Request Type | Content-Type |
|---|---|---|
| https://api.personaclick.com/subscriptions/subscribe_for_product_price | POST | application/json |
Parameters
| Name | Type | Requirement | Description | ||
|---|---|---|---|---|---|
| shop_id | string | required | Unique Store Key in PersonaClick. Located there: Account > Settings > Store Settings | ||
| did | string | required | Unique Device ID. See "Initialization (REST API)" for information about getting and using Device ID.
| ||
| item_id | string/number | required | Product ID | ||
| price | number | required | Current Price of Product | ||
| string | optionally | User Email. Will be added (updated) to the user's profile is used in the request. |
API Response Code
HTTP status code | Description |
|---|---|
| 200 OK | The request was successful. |
| 400 Bad Request | See the "message" property of the API response for details. |
| 403 Forbidden | See the "message" property of the API response for details. |
Example of use
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl 'https://api.personaclick.com/subscriptions/subscribe_for_product_price' \
-X 'POST' \
-H 'content-type: application/json' \
-d '{"shop_id":"0d42fd8b713d0752776ca589cc0056","did":"vxlwRZ7Cnk","item_id":"100500","email":"john.doe@examplemail.com","price":146}' |
Unsubscribe from the "Price Drop" trigger
Method Objective
The method unsubscribes the user from an email notification of a product price decrease.
Request
| Endpoint | Request Type | Content-Type |
|---|---|---|
| https://api.personaclick.com/subscriptions/unsubscribe_from_product_price | POST | application/json |
Parameters
| Name | Type | Requirement | Description | ||
|---|---|---|---|---|---|
| shop_id | string | required | Unique Store Key in PersonaClick. Located there: Account > Settings > Store Settings | ||
| did | string | required | Unique Device ID. See "Initialization (REST API)" for information about getting and using Device ID.
| ||
| item_ids | string | required | Product IDs, separated by commas. Can have an empty value to remove subscriptions for all products. | ||
| string | required | User Email |
API Response Code
HTTP status code | Description |
|---|---|
| 200 OK | The request was successful. |
| 400 Bad Request | See the "message" property of the API response for details. |
| 403 Forbidden | See the "message" property of the API response for details. |
Examples of use
| Code Block | ||||
|---|---|---|---|---|
| ||||
# unsubscribe from notifications for selected products
curl 'https://api.personaclick.com/subscriptions/unsubscribe_from_product_price' \
-X 'POST' \
-H 'content-type: application/json' \
-d '{"item_ids":"PRODUCT_ID1,PRODUCT_ID2","email":"john.doe@examplemail.com","shop_id":"0d42fd8b713d0752776ca589cc0056&did=vxlwRZ7Cnk"}'
# cancel notifications for all products
curl 'https://api.personaclick.com/subscriptions/unsubscribe_from_product_price' \
-X 'POST' \
-H 'content-type: application/json' \
-d '{"item_ids":"","email":"john.doe@examplemail.com","shop_id":"0d42fd8b713d0752776ca589cc0056&did=vxlwRZ7Cnk"}' |
Checking the "Price Drop" trigger subscription
Method Objective
The method allows checking the subscription status of the "Price Drop" trigger.
Request
| Endpoint | Request Type |
|---|---|
| https://api.personaclick.com/products/check_price_drop_subscription | GET |
Parameters
| Note |
|---|
Only parameters related to the profile update request are listed here. See "Basic Details" above for more information on required parameters and the API endpoint. |
| Name | Type | Requirement | Description |
|---|---|---|---|
| shop_id | string | required | Unique Store Key in PersonaClick. Located there: Account > Settings > Store Settings |
| shop_secret | string | required | Store Secret Key in PersonaClick. Located there: Account > Settings > Store Settings |
| item_id | string/number | required | Product ID |
| string | One of the available ones is required | Email for subscription checking | |
| phone | string | Phone for subscription checking | |
| loyalty_id | string | Loyalty ID for subscription checking |
API response properties
| Name | Type | Description |
|---|---|---|
| status | boolean | Shows whether or not there is a trigger subscription for the product |
Example of use
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl 'https://api.personaclick.com/products/check_price_drop_subscription?email=john.doe%40examplemail.com&shop_id=0d42fd8b713d0752776ca589cc0056&shop_secret=0123456789abcdef0123456789abcdef&item_id=100500' |
| Column | ||||
|---|---|---|---|---|
Page Navigation
|
Related Pages
|