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>

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"
}

Response

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

**before placing the order, call this API with action=“list” with standard timeout of whatever seconds is applicable, (30 sec should be max), if this api does not respond or if it responds with the below error response, kindly do not call this api again with action = ‘perform’ or action = ‘revert’ to avoid order placing issue at Shiprocket

calling this api with action=“list” works like heartbeat, if there is no heartbeat please don’t proceed with remaining apis**

Error Response

{
	meta: {
		code: 422 (a non 200 response code)
		... other props
	}
	data: {
		... other props
	}
}

List

• used to get the discount that the customer is eligible