Customers

List customers

GET/rest_api/v1/customers

Parameters

X-Joy-Loyalty-App-Keyheader · stringOptional

App ID of your shop which retrieved from the Settings page

X-Joy-Loyalty-Secret-Keyheader · stringOptional

Secret Key of your shop which retrieved from the Settings page

Responses

200OK

dataobject[]Optional

Show properties

idstringOptional

shopifyCustomerIdnumberOptional

emailstringOptional

pointnumberOptional

createdAtstring · date-timeOptional

updatedAtstring · date-timeOptional

totalSpentnumberOptional

orderCountnumberOptional

acceptsMarketingbooleanOptional

namestringOptional

statestringOptional

tierIdstringOptional

tierPointnumberOptional

phonenumberOptional

pointsRemainnumberOptional

pageInfoobjectOptional

Show properties

hasPrebooleanOptional

hasNextbooleanOptional

countnumberOptional

GET/rest_api/v1/customers

GET /rest_api/v1/customers HTTP/1.1
Host: dev-api.joy.so
Accept: */*

200OK

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

Get a customer

GET/rest_api/v1/customers/{customerId}

Parameters

X-Joy-Loyalty-App-Keyheader · stringOptional

App ID of your shop which retrieved from the Settings page

X-Joy-Loyalty-Secret-Keyheader · stringOptional

Secret of your shop which retrieved from /settings/managingKey

customerIdpath · stringRequired

Responses

200OK

dataobjectOptional

Show properties

idstringOptional

shopifyCustomerIdnumberOptional

emailstringOptional

pointnumberOptional

createdAtstring · date-timeOptional

updatedAtstring · date-timeOptional

totalSpentnumberOptional

orderCountnumberOptional

acceptsMarketingbooleanOptional

namestringOptional

statestringOptional

tierIdstringOptional

tierPointnumberOptional

phonenumberOptional

pointsRemainnumberOptional

GET/rest_api/v1/customers/{customerId}

GET /rest_api/v1/customers/{customerId} HTTP/1.1
Host: dev-api.joy.so
Accept: */*

200OK

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

Get customer by Shopify ID

GET/rest_api/v1/customers/shopify-id/{id}

Retrieve customer information using Shopify customer ID

Parameters

idpath · integerRequired

Shopify customer ID

Responses

200OK

dataobjectOptional

Show properties

emailstringOptional

namestringOptional

typestringOptional

statestringOptional

orderCountintegerOptional

totalSpentnumberOptional

shopifyCustomerIdintegerOptional

acceptsMarketingbooleanOptional

phonestringOptional

shopIdstringOptional

insertedBigquerybooleanOptional

earnSignUpbooleanOptional

hasPointbooleanOptional

like_facebookbooleanOptional

usedMilestoneEarnPointinteger[]Optional

latestActivitystring · date-timeOptional

pointintegerOptional

hasTierbooleanOptional

tierUpdatedAtstring · date-timeOptional

tierIdstringOptional

tierPointintegerOptional

createdAtstring · date-timeOptional

updatedAtstring · date-timeOptional

idstringOptional

pointsRemainintegerOptional

tierNamestringOptional

GET/rest_api/v1/customers/shopify-id/{id}

GET /rest_api/v1/customers/shopify-id/{id} HTTP/1.1
Host: dev-api.joy.so
Accept: */*

200OK

{
  "data": {
    "email": "string",
    "name": "string",
    "type": "string",
    "state": "string",
    "orderCount": 1,
    "totalSpent": 1,
    "shopifyCustomerId": 1,
    "acceptsMarketing": true,
    "phone": "string",
    "shopId": "string",
    "insertedBigquery": true,
    "earnSignUp": true,
    "hasPoint": true,
    "like_facebook": true,
    "usedMilestoneEarnPoint": [
      1
    ],
    "latestActivity": "2024-01-15T10:30:00.000Z",
    "point": 1,
    "hasTier": true,
    "tierUpdatedAt": "2024-01-15T10:30:00.000Z",
    "tierId": "string",
    "tierPoint": 1,
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-15T10:30:00.000Z",
    "id": "string",
    "pointsRemain": 1,
    "tierName": "string"
  }
}

API references Earning programs