# ポイント数
ポイント数(point balance)のエンドポイントは特定の顧客のEasyPointsデータを返します。
# ベースルート
/api/shopify/point_balances
# フィールド
以下のフィールドが返ってきます:
キー | タイプ | 説明 |
---|---|---|
id | 文字列 | 顧客のShopify ID |
expiration_delay | 整数 | 顧客のポイントが期限切れになるまでショップが待機する期間(月単位) |
expires_at | 文字列 | 顧客の現在のポイント有効期限日時 |
point_balance | 整数 | 顧客の保有中ポイント数 |
# 単一のポイント数の取得
# ルート
以下のGETルートを使用して単一の顧客のポイント数を取得するには、:id
を取得したい顧客のShopify IDと書き換えます。
/api/shopify/point_balances/:id
# 事例
リクエストと結果の例:
GET "https://loyalty.slrs.io/api/shopify/point_balances/123"
{
"data": {
"expiration_delay": 3,
"expires_at": "2020-11-14T07:00:35.000000Z",
"id": "123",
"point_balance": 800
}
}