Introducing pockets Administration API for the Pockets administration app for Shopify.
Pockets Administration app for Shopify provides your eCommerce retailer a pockets idea to your prospects.
This permits your prospects to pay by way of pockets, recharge the pockets, and may even get refunds within the pockets and rather more. Now, the retailers utilizing the Pockets administration app can get entry to the Pockets Administration API utilizing the app.
API stands for an Software programming interface. It’s a set of instruments and protocols that may assist you construct sync and rather more.
POST Technique of the API is the place builders can interface with different APIs or programs to get the specified end result. Furthermore, it’s extra typically utilized to create new sources.
GET Technique of API is to learn or retrieve a illustration of a useful resource or info.
PUT Technique of the API is the place builders can interface with different APIs or programs to get the specified end result. It’s extra typically utilized to replace present sources.
Then, get the bottom URL.
Base URL – https://app-sp.webkul.com/wallet-api/public/api/doc
Use of Pockets Administration API
Firstly, it’s good to perceive precisely what actions you carry out by way of the given APIs. Pockets Administration API helps you to do the next features:
POST/api/person/register.json
– Used to register a brand new person. Open API and no authentication is required.
then, proceed to test the parameters.
Parameters
| Title | Description |
| Consumer element object (question) | That is person knowledge |
POST/api/person/refresh/token.json
– Create an entry token utilizing the refresh token.
then, proceed to test the parameters.
Parameters
| Title | Description |
| Consumer element object (question) | That is person knowledge |
GET/api/cart/cashback.json
– Get cashback info for the entered quantity
then, proceed to test the parameters.
Parameters
| Title | Description |
| total_amount string (question) | Enter an quantity to test the cart cashback particulars. Default worth : null |
GET/api/product/cashback.json
– Get cashback for the product.
Be aware – Use comma separation, to test a number of handles on the similar time.
then, proceed to test the parameters.
Parameters
| Title | Description |
| handles string (question) | Enter the product deal with to get the cashback info. |
POST/api/add/cart/cashback.json
– Used to create cashback rule for cart quantity.
then, proceed to test the parameters.
Parameters
| Title | Description |
| Consumer element object (question) | That is person knowledge |
POST/api/add/product/cashback.json
– Used to create cashback rule for product
then, proceed to test the parameters.
Parameters
| Title | Description |
| Consumer element object (question) | That is person knowledge |
Get/api/pockets/pay.json
– Used to get a reduction coupon for entered quantity.
then, proceed to test the parameters.
Parameters
| Title | Description |
| customer_email string (question) | Enter the e-mail id of the client. |
| quantity string (question) | Enter the quantity must pay by way of pockets. Default worth: null |
POST/api/pockets/{transactionId}/refundrequest.json
– Used to generate a refund request
then, proceed to test the parameters.
Parameters
| Title | Description |
| Requested Quantity object (question) | That is the requested refund quantity. |
| transactionId * string (path) | Enter the transaction Id of the transaction. |
GET/api/pockets/transaction/particulars/electronic mail.json
– Used to get transaction particulars.
Be aware –
then, proceed to test the parameters.
Parameters
| Title | Description |
| customer_email string (question) | Returns a particular consequence if the Id matches. Default worth: null |
Be aware – The client electronic mail entered right here will present all of the transaction particulars for the client.
Right here, the transactionId from the transaction particulars can be used to generate the refund request.
GET/api/pockets.json
– Used to get the present pockets stability of the client
then, proceed to test the parameters.
Parameters
| Title | Description |
| customer_email string (question) | Returns a particular consequence if the Id matches. Default worth: null |
PUT/api/pockets.json
– Used to replace pockets quantity.
then, proceed to test the parameters.
Parameters
| Title | Description |
| customer_email string (question) | That is the quantity to be added Returns a particular consequence if the Id is matched. Default worth: null |
| add_amount string (question) | The quantity added by Admin/Buyer Default worth: null |
| added_by string (question) | Quantity added by Admin/Buyer Default worth: null |
access_token – That is the entry token from the Pockets Administration API credentials.
Refresh_token – That is the refresh token from Pockets Administration API credentials.
GET/api/cart/cashback.json
total_amount – It’s the quantity used to test the cart cashback particulars
GET/api/product/cashback.json
Handles – It’s the product deal with
POST/api/add/cart/cashback.json
cashback_amt – cashback quantity the client will obtain.
cashback_type – It’s both a proportion or a set worth.
date_from – Begin date for a cashback.
date_to – Finish date for a cashback.
target_amt – Min cart quantity on which the client will obtain the cashback quantity.
POST/api/add/product/cashback.json
cashback_amt – cashback quantity the client will obtain.
cashback_type – It’s both a proportion or a set worth.
date_from – Begin date for a cashback.
date_to – Finish date for a cashback.
handles – It’s the shopify product deal with
GET/api/pockets/pay.json
customer_email – The e-mail id of the client must be entered right here.
quantity – That is the quantity that’s to be paid by pockets
Refund Request API Properties
POST/api/pockets/{transactionId}/refundrequest.json
Requested Quantity – That is the requested refund quantity by the client.
transactionId – That is the transaction ID that can be extracted from the GET/api/pockets/transaction/particulars/electronic mail.json wherein the client electronic mail can be entered and the transaction particulars can be generated.
GET/api/pockets/transaction/particulars/electronic mail.json
customer_email – When a buyer electronic mail is entered, the transaction particulars are generated for the client.
Be aware – The transaction particulars have the transaction ID which is utilized in POST/api/pockets/{transactionId}/refundrequest.json.
GET/api/pockets.json
customer_email – On coming into the e-mail tackle of the client, the present pockets stability of the client is generated.
PUT/api/pockets.json
customer_email – Enter the client e-mail for whom the pockets quantity is to be up to date
add_amount – Enter the quantity that’s to be added.
added_by – Added by Admin/Buyer.
In conclusion, you possibly can check with the hyperlink given beneath to test the DEMO of the Pockets Administration App for Shopify: https://wallet-management-demo-store.myshopify.com/pages/demo-details
Demo retailer password: 12345
Furthermore, should you want any form of help/Consultancy then please increase a ticket at http://webkul.uvdesk.com/ or drop an electronic mail at [email protected]
Thanks for studying this weblog!!! 🙂
Introducing pockets Administration API for the Pockets administration app for Shopify.
Pockets Administration app for Shopify provides your eCommerce retailer a pockets idea to your prospects.
This permits your prospects to pay by way of pockets, recharge the pockets, and may even get refunds within the pockets and rather more. Now, the retailers utilizing the Pockets administration app can get entry to the Pockets Administration API utilizing the app.
API stands for an Software programming interface. It’s a set of instruments and protocols that may assist you construct sync and rather more.
POST Technique of the API is the place builders can interface with different APIs or programs to get the specified end result. Furthermore, it’s extra typically utilized to create new sources.
GET Technique of API is to learn or retrieve a illustration of a useful resource or info.
PUT Technique of the API is the place builders can interface with different APIs or programs to get the specified end result. It’s extra typically utilized to replace present sources.
Then, get the bottom URL.
Base URL – https://app-sp.webkul.com/wallet-api/public/api/doc
Use of Pockets Administration API
Firstly, it’s good to perceive precisely what actions you carry out by way of the given APIs. Pockets Administration API helps you to do the next features:
POST/api/person/register.json
– Used to register a brand new person. Open API and no authentication is required.
then, proceed to test the parameters.
Parameters
| Title | Description |
| Consumer element object (question) | That is person knowledge |
POST/api/person/refresh/token.json
– Create an entry token utilizing the refresh token.
then, proceed to test the parameters.
Parameters
| Title | Description |
| Consumer element object (question) | That is person knowledge |
GET/api/cart/cashback.json
– Get cashback info for the entered quantity
then, proceed to test the parameters.
Parameters
| Title | Description |
| total_amount string (question) | Enter an quantity to test the cart cashback particulars. Default worth : null |
GET/api/product/cashback.json
– Get cashback for the product.
Be aware – Use comma separation, to test a number of handles on the similar time.
then, proceed to test the parameters.
Parameters
| Title | Description |
| handles string (question) | Enter the product deal with to get the cashback info. |
POST/api/add/cart/cashback.json
– Used to create cashback rule for cart quantity.
then, proceed to test the parameters.
Parameters
| Title | Description |
| Consumer element object (question) | That is person knowledge |
POST/api/add/product/cashback.json
– Used to create cashback rule for product
then, proceed to test the parameters.
Parameters
| Title | Description |
| Consumer element object (question) | That is person knowledge |
Get/api/pockets/pay.json
– Used to get a reduction coupon for entered quantity.
then, proceed to test the parameters.
Parameters
| Title | Description |
| customer_email string (question) | Enter the e-mail id of the client. |
| quantity string (question) | Enter the quantity must pay by way of pockets. Default worth: null |
POST/api/pockets/{transactionId}/refundrequest.json
– Used to generate a refund request
then, proceed to test the parameters.
Parameters
| Title | Description |
| Requested Quantity object (question) | That is the requested refund quantity. |
| transactionId * string (path) | Enter the transaction Id of the transaction. |
GET/api/pockets/transaction/particulars/electronic mail.json
– Used to get transaction particulars.
Be aware –
then, proceed to test the parameters.
Parameters
| Title | Description |
| customer_email string (question) | Returns a particular consequence if the Id matches. Default worth: null |
Be aware – The client electronic mail entered right here will present all of the transaction particulars for the client.
Right here, the transactionId from the transaction particulars can be used to generate the refund request.
GET/api/pockets.json
– Used to get the present pockets stability of the client
then, proceed to test the parameters.
Parameters
| Title | Description |
| customer_email string (question) | Returns a particular consequence if the Id matches. Default worth: null |
PUT/api/pockets.json
– Used to replace pockets quantity.
then, proceed to test the parameters.
Parameters
| Title | Description |
| customer_email string (question) | That is the quantity to be added Returns a particular consequence if the Id is matched. Default worth: null |
| add_amount string (question) | The quantity added by Admin/Buyer Default worth: null |
| added_by string (question) | Quantity added by Admin/Buyer Default worth: null |
access_token – That is the entry token from the Pockets Administration API credentials.
Refresh_token – That is the refresh token from Pockets Administration API credentials.
GET/api/cart/cashback.json
total_amount – It’s the quantity used to test the cart cashback particulars
GET/api/product/cashback.json
Handles – It’s the product deal with
POST/api/add/cart/cashback.json
cashback_amt – cashback quantity the client will obtain.
cashback_type – It’s both a proportion or a set worth.
date_from – Begin date for a cashback.
date_to – Finish date for a cashback.
target_amt – Min cart quantity on which the client will obtain the cashback quantity.
POST/api/add/product/cashback.json
cashback_amt – cashback quantity the client will obtain.
cashback_type – It’s both a proportion or a set worth.
date_from – Begin date for a cashback.
date_to – Finish date for a cashback.
handles – It’s the shopify product deal with
GET/api/pockets/pay.json
customer_email – The e-mail id of the client must be entered right here.
quantity – That is the quantity that’s to be paid by pockets
Refund Request API Properties
POST/api/pockets/{transactionId}/refundrequest.json
Requested Quantity – That is the requested refund quantity by the client.
transactionId – That is the transaction ID that can be extracted from the GET/api/pockets/transaction/particulars/electronic mail.json wherein the client electronic mail can be entered and the transaction particulars can be generated.
GET/api/pockets/transaction/particulars/electronic mail.json
customer_email – When a buyer electronic mail is entered, the transaction particulars are generated for the client.
Be aware – The transaction particulars have the transaction ID which is utilized in POST/api/pockets/{transactionId}/refundrequest.json.
GET/api/pockets.json
customer_email – On coming into the e-mail tackle of the client, the present pockets stability of the client is generated.
PUT/api/pockets.json
customer_email – Enter the client e-mail for whom the pockets quantity is to be up to date
add_amount – Enter the quantity that’s to be added.
added_by – Added by Admin/Buyer.
In conclusion, you possibly can check with the hyperlink given beneath to test the DEMO of the Pockets Administration App for Shopify: https://wallet-management-demo-store.myshopify.com/pages/demo-details
Demo retailer password: 12345
Furthermore, should you want any form of help/Consultancy then please increase a ticket at http://webkul.uvdesk.com/ or drop an electronic mail at [email protected]
Thanks for studying this weblog!!! 🙂