Customers
Header parameters
X-Joy-Loyalty-App-KeystringOptionalExample:
App ID of your shop which retrieved from the Settings page
{{appKey}}
X-Joy-Loyalty-Secret-KeystringOptionalExample:
Secret Key of your shop which retrieved from the Settings page
{{secretKey}}
Responses
200
OK
application/json
get
GET /rest_api/v1/customers HTTP/1.1
Host: dev-api.joy.so
Accept: */*
200
OK
{
"data": [
{
"id": "o9AQeUCXYDjbeFm7vAKy",
"shopifyCustomerId": 7603687882987,
"email": "[email protected]",
"point": 999600,
"createdAt": "2024-08-26T10:28:33.862Z",
"updatedAt": "2024-09-26T07:53:28.014Z",
"totalSpent": 0,
"orderCount": 0,
"acceptsMarketing": false,
"name": "anh anh",
"state": "enabled",
"tierId": "dvlOpwxsdATG5RYgr0gz",
"tierPoint": 0,
"type": "member",
"shopId": "umN0f3GKyQC3XS1AwVWg",
"hasPoint": true,
"urlReferral": "https://inviteee.to/i/g5ND",
"latestActivity": "2024-08-27T08:24:07.578Z",
"phone": null,
"hasTier": false,
"pointsRemain": 500
}
],
"pageInfo": {
"hasPre": false,
"hasNext": false
},
"count": 1
}
Path parameters
customerIdstringRequired
Header parameters
X-Joy-Loyalty-App-KeystringOptionalExample:
App ID of your shop which retrieved from the Settings page
{{appKey}}
X-Joy-Loyalty-Secret-KeystringOptionalExample:
Secret of your shop which retrieved from /settings/managingKey
{{secretKey}}
Responses
200
OK
application/json
get
GET /rest_api/v1/customers/{customerId} HTTP/1.1
Host: dev-api.joy.so
Accept: */*
200
OK
{
"data": {
"id": "o9AQeUCXYDjbeFm7vAKy",
"shopifyCustomerId": 7603687882987,
"totalSpent": 0,
"orderCount": 0,
"name": "anh anh",
"state": "enabled",
"shopId": "umN0f3GKyQC3XS1AwVWg",
"type": "member",
"acceptsMarketing": false,
"email": "[email protected]",
"createdAt": "2024-08-26T10:28:33.862Z",
"hasPoint": true,
"urlReferral": "https://inviteee.to/i/g5ND",
"latestActivity": "2024-08-27T08:24:07.578Z",
"point": 999600,
"updatedAt": "2024-09-26T07:53:28.014Z",
"phone": null,
"tierId": "dvlOpwxsdATG5RYgr0gz",
"hasTier": false,
"tierPoint": 0,
"tierName": "Silver",
"pointsRemain": 500
}
}
Retrieve customer information using Shopify customer ID
Path parameters
idintegerRequired
Shopify customer ID
Responses
200
OK
application/json
get
GET /customers/shopify-id/{id} HTTP/1.1
Host: dev-api.joy.so
Accept: */*
200
OK
{
"data": {
"email": "text",
"name": "text",
"type": "text",
"state": "text",
"orderCount": 1,
"totalSpent": 1,
"shopifyCustomerId": 1,
"acceptsMarketing": true,
"phone": "text",
"shopId": "text",
"insertedBigquery": true,
"earnSignUp": true,
"hasPoint": true,
"like_facebook": true,
"usedMilestoneEarnPoint": [
1
],
"latestActivity": "2025-06-27T10:40:38.714Z",
"point": 1,
"hasTier": true,
"tierUpdatedAt": "2025-06-27T10:40:38.714Z",
"tierId": "text",
"tierPoint": 1,
"createdAt": "2025-06-27T10:40:38.714Z",
"updatedAt": "2025-06-27T10:40:38.714Z",
"id": "text",
"pointsRemain": 1,
"tierName": "text"
}
}
Last updated