Customer

Get customer

get details of single customer using id

GET https://rewards-api.superassistant.io/customer

Query Parameters

Name	Type	Description
id*	Number	customer id generated by Shopify

Headers

Name	Type	Description
x-api-key*	String	API Key

200 Success

{
    "customerId": 5389371506881,
    "name": "Chirag Gupta",
    "email": "[e-mail]",
    "points": 0,
    "birth_day": null,
    "birth_month": null,
    "tierName": "bronze",
    "isCustomerBan": false,
    "referralsCompleted": 0,
    "referralLink": "https://super-neil-test.myshopify.com/?ref=SUPER5301627622632"
}

404: Not Found Customer not found

{
    "message": "Customer not found"
}

500: Internal Server Error Error

Get all customers

get details of all customers

GET https://rewards-api.superassistant.io/customer/all

Query Parameters

Name	Type	Description
page	Number	default page is 1
limit	Number	default limit is 10 and max limit is 100

Headers

Name	Type	Description
x-api-key*	String	API key

200: OK Success

{
    "customers": [
        {
            "customerId": 5389371506881,
            "name": "Chirag Gupta",
            "email": "[e-mail]",
            "points": 0,
            "birth_day": null,
            "birth_month": null,
            "tierName": "bronze",
            "isCustomerBan": false,
            "referralsCompleted": 0
        }
    ],
    "page": 1,
    "totalCustomers": 1268
}

400: Bad Request

{
   message: "No customers Found",
}

500: Internal Server Error Error

Ban customer

ban customer form your rewards program

PUT https://rewards-api.superassistant.io/customer/ban

Headers

Name	Type	Description
x-api-key*	String	API key

Request Body

Name	Type	Description
id*	Number	customer id generated by Shopify
banned*	Boolean

200: OK

"success"

404: Not Found

{ message: "Customer not found" }

500: Internal Server Error Error

Allot or Deduct points

Allot or deduct points manually to customer

PUT https://rewards-api.superassistant.io/customer/points

Headers

Name	Type	Description
x-api-key*	String	API Key

Request Body

Name	Type	Description
id*	String	customer id generated by Shopify
points*	Number	use - in front to deduct points
notifyCustomer*	Boolean	we'll notify user by sending email
emailBody	String	required if notifyCustomer is true
emailSubject	String	required if notifyCustomer is true. Hello {{customer_name}} - A small Gift From Us
reason	String

200: OK

"success"

404: Not Found

{ message: "Customer not found" }

Issue Gift Card

issue gift card for customer

POST https://rewards-api.superassistant.io/customer/giftcard

Headers

Name	Type	Description
x-api-key*	String	API Key

Request Body

Name	Type	Description
id*	String	customer id generated by Shopify
initial_value*	String	gift card amount
expiryDate	String	expiry date format (YYYY-MM-DD)
emailBody*	String	email body
emailSubject*	String	Hello {{customer_name}} - A small Gift From Us
reason	String	for internal use

200: OK

"success"

404: Not Found

{ message: "Customer not found" }

500: Internal Server Error Error