Point Claims Request API End Point
Post
https://api.cogginsstore.com/api/v1/points?csapikey=yourapikey
Clients will be provided with an API key after their store’s domain name, and SSL certificate
have been acquired and deployed.
Claim Request Payload
{
"amount": 400,
"email": "test011@atest.com",
"customerType": "Internal",
"expires": 1
}
Amount
Amount of points to allocate for the given request, this is a required field.
Email (optional)
Email address to associate to the given request, this is an optional field.
If not provided any customer can use the claimURL to claim the points.
Customer Type (optional)
Associate or update customer to the specified customer type, this is an optional field.
Valid customer type values are implementation dependent, clients will be provide a list of
valid value should the they be interested in this functionality.
Expiration (optional)
Set the expiration of the claim by the number of days from the creation of the claim request,
this is an optional field.
Depending configuration omitting this value will either result in the claim request defaulting
to a preconfigured default or have no expiration at all. Note, time is not factored into the
expiration period.

Claim Response Payload
{
"amount": 400,
"email": "test012@atest.com",
"customerType": "Internal",
"expires": 1,
"claimToken": "6037d53f-4088-43a2-8ab6-b5cdcd6de290",
"claimUrl": "https://store.yourdomain.com/claim/points/
6037d53f408843a28ab6b5cdcd6de290",
"created": true
}
ClaimToken
A universally unique identifier representing a point claim.
ClaimUrl
Url provided to customer to claim their points.
Created
A boolean value confirming the claim request was accepted and created.
Api Usage Notes
A request payloads must be submitted in a array, see request format below. The end point accepts
multiple payloads in a single request, clients are encouraged to submit requests in bulk.

Point Claim Request Format
[
{
"amount": 400,
"email": "test011@atest.com",
"customerType": "Internal",
"expires": 1
}
]
 

Point Claim Response Format
[
{
"amount": 400,
"email": "test012@atest.com",
"customerType": "Internal",
"expires": 1,
"claimToken": "6037d53f-4088-43a2-8ab6-b5cdcd6de290",
"claimUrl": "https://store.yourdomain.com/claim/points/
6037d53f408843a28ab6b5cdcd6de290",
"created": true
}
]
 

Point Lookup
GET
https://api.cogginsstore.com/api/v1/points /{csapikey=csapikey:guid}/email/{email}/Full
This returns the Available points and used points for a given user
Lookup Response Format
{
“AvailablePoints”: 9906
“UsedPoints”: 5120
}

Edit User Point Balance

Post

https://api.cogginsstore.com/api/v1/points/myAPIkey/INSTANT

[
 { "amount": 400,
 "email": "atest@corderindustries.com" },

 { "amount": -100,
"email": "atest2@corderindustries.com " },
 ]