The idea is to allow users with loyalty coins to redeem their loyalty coins and purchase at discounted rate.

Postman collection of the APIs

Nector Shiprocket Checkout APIs.postman_collection.json

Assuming “shopify” for below examples

• There is a single endpoint platform.nector.io/api/open/integrations/shiprocketwebhook/:webhook_id that you have to call with different “action” each time.
• Below the general structure of the API payload and response
• The primary identifier for a customer when making the api call, can be either their “mobile number” or their “shopify customer id”
• The “action” field in the payload decides the operation that is performed.
  • if “action” is “list”, then the discount that the customer is eligible for is returned
  • if “action” is “perform”, then the coins are deducted from the customer’s wallet
  • if “action” is “revert”, then the coins are given back to the customer (will be useful if the perform action is called but then the order processesing failed for some other reason, then “revert” can be called).
• The webhook_id part of the endpoint is specific to each merchant, which can be accessed from the nector dashboard or can be provided by the nector team as well.

<aside> ⚠️ Don’t call this API from frontend

</aside>

Nector Wallets

We have recently added support for multiple wallets on Nector.

1. Coins Wallet: This is the same default wallet that is being used for storage and redemption of all the loyalty points.
2. Credits Wallet: This is the new type of wallet that we have added and this wallet is meant for gift cards, refunds, etc. The value of 1 credit in this wallet will always be equal to Rs. 1 or $1. Customers will be able to use their credits fully without any restriction.

This is an optional wallet that a brand may or may not be using.

So in the below APIs we have added an option for choosing from which wallet the redemption should happen. Redemption can happen only from the coins wallet, only from the credit wallet or from both the wallets. If redemption is going to happen from both the wallets, first all the credits will be used and then the loyalty coins discount would be applied on the remaining cart amount.

Request

POST - platform.nector.io/api/open/integrations/shiprocketwebhook/:webhook_id

{
customer_id: "this needs to be shopify prefixed customer id (Ex. shopify-458737453897), one of customer_id or mobile is required",
mobile: "this is 10 digit mobile number, one of customer_id or mobile is required",
action: "list, perform, revert, perform_unsafe, revert_unsafe",
amount: "this is final cart amount based on which the discount will be calculated"
wallet_type: "can be one of: coins, credits or coins_and_credits (default: coins)"
}

Response

{
	meta: {
		... other props
	}
	data: {
		... other props
	}
}