Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »

Subscribe to the "Back in Stock" trigger

Method Objective

The method subscribes the user to the notifications that the product is available.

Request

EndpointRequest TypeContent-Type
https://api.personaclick.com/subscriptions/subscribe_for_product_availablePOSTapplication/x-www-form-urlencoded

Parameters

NameTypeRequirementDescription
shop_idstringrequiredUnique Store Key in PersonaClick. Located there: Account > Settings > Store Settings
didstringrequiredUnique Device ID. See "Initialization (REST API)" for information about getting and using Device ID.
item_idstring/numberrequiredProduct ID
emailstringoptionallyUser Email. Will be added (updated) to the user's profile is used in the request.
properties[fashion_size]stringoptionally

It allows specifying the size as an additional property of the product in the subscription.

API Response Code

HTTP status code

Description
200 OK

The request was successful.

400 Bad RequestSee the "message" property of the API response for details.
403 ForbiddenSee the "message" property of the API response for details.

Example of use

curl 'https://api.personaclick.com/subscriptions/subscribe_for_product_available' \
  -X 'POST' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d 'shop_id=0d42fd8b713d0752776ca589cc0056&did=vxlwRZ7Cnk&item_id=100500&email=john.doe%40examplemail.com&properties%5Bfashion_size%5D=XL'

Subscribe to the "Price Drop" trigger

Method Objective

The method subscribes the user to the notifications of a product price decrease.

Request

EndpointRequest TypeContent-Type
https://api.personaclick.com/subscriptions/subscribe_for_product_pricePOSTapplication/x-www-form-urlencoded

Parameters

NameTypeRequirementDescription
shop_idstringrequiredUnique Store Key in PersonaClick. Located there: Account > Settings > Store Settings
didstringrequiredUnique Device ID. See "Initialization (REST API)" for information about getting and using Device ID.
item_idstring/numberrequiredProduct ID
pricenumberrequiredCurrent Price of Product
emailstringoptionallyUser Email. Will be added (updated) to the user's profile is used in the request.
properties[fashion_size]stringoptionally

It allows specifying the size as an additional property of the product in the subscription.

API Response Code

HTTP status code

Description
200 OK

The request was successful.

400 Bad RequestSee the "message" property of the API response for details.
403 ForbiddenSee the "message" property of the API response for details.

Example of use

curl 'https://api.personaclick.com/subscriptions/subscribe_for_product_price' \
  -X 'POST' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d 'shop_id=0d42fd8b713d0752776ca589cc0056&did=vxlwRZ7Cnk&item_id=100500&email=john.doe%40examplemail.com&price=146&properties%5Bfashion_size%5D=XL'

Checking the "Back in Stock" trigger subscription

Method Objective

The method allows checking the subscription status of the "Back in Stock" trigger.

Request

EndpointRequest Type
https://api.personaclick.com/products/check_product_available_subscriptionGET

Parameters

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.

NameTypeRequirementDescription
shop_idstringrequiredUnique Store Key in PersonaClick. Located there: Account > Settings > Store Settings
shop_secretstringrequiredStore Secret Key in PersonaClick. Located there: Account > Settings > Store Settings
item_idstring/numberrequiredProduct ID
emailstringOne of the available ones is requiredEmail for subscription checking
phonestringPhone for subscription checking
loyalty_idstringLoyalty ID for subscription checking

API response properties

NameTypeDescription
statusbooleanShows whether or not there is a trigger subscription for the product

Example of use

curl 'https://api.personaclick.com/products/check_product_available_subscription?email=john.doe%40examplemail.com&shop_id=0d42fd8b713d0752776ca589cc0056&shop_secret=0123456789abcdef0123456789abcdef&item_id=100500'

Checking the "Price Drop" trigger subscription

Method Objective

The method allows checking the subscription status of the "Price Drop" trigger.

Request

EndpointRequest Type
https://api.personaclick.com/products/check_price_drop_subscriptionGET

Parameters

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.

NameTypeRequirementDescription
shop_idstringrequiredUnique Store Key in PersonaClick. Located there: Account > Settings > Store Settings
shop_secretstringrequiredStore Secret Key in PersonaClick. Located there: Account > Settings > Store Settings
item_idstring/numberrequiredProduct ID
emailstringOne of the available ones is requiredEmail for subscription checking
phonestringPhone for subscription checking
loyalty_idstringLoyalty ID for subscription checking

API response properties

NameTypeDescription
statusbooleanShows whether or not there is a trigger subscription for the product

Example of use

curl 'https://api.personaclick.com/products/check_price_drop_subscription?email=john.doe%40examplemail.com&shop_id=0d42fd8b713d0752776ca589cc0056&shop_secret=0123456789abcdef0123456789abcdef&item_id=100500'

  • No labels

Copyright 2018-2024 PersonaClick