# ポイント割り当て

ポイント割り当て(point Allotments)エンドポイントはポイント数の更新を行います。

# ベースルート

https://loyalty.slrs.io/api/shopify/point_allotments

# フィールド

以下のフィールドが返ってきます:

キー タイプ 説明
id 文字列 ポイント割り当て先のEasyPoints ID
point_value 整数 顧客のポイントが期限切れになるまでショップが待機する期間(月単位)
inserted_at 文字列 顧客の現在のポイント有効期限日時
point_balance JSON "ポイント割り当て" をご覧ください

# ポイント割り当ての作成

# ルート

以下のPOSTルートを使用して単一の顧客にポイント割り当てを作成する。

/api/shopify/point_allotments

# フィールドの提出

ポイント割り当てを作成するには、、以下のフィールド提出します。

キー タイプ 必要 説明
customer_id 文字列 ✔️ ポイントを割り当てられる顧客のShopify ID
point_value 整数 ✔️ 割り当てられるポイント数(プラス又はマイナス)

# 事例

リクエストと結果の例

POST "https://loyalty.slrs.io/api/shopify/point_allotments"
Body {
  "point_value": 200,
  "customer_id": "123"
}
{
  "data": {
    "id": "36ce8920-4a65-11eb-98c6-000c291828e7",
    "inserted_at": "2020-12-30T06:06:53.000000",
    "point_balance": {
      "expiration_delay": 3,
      "expires_at": "2021-03-20T23:51:09.000000Z",
      "id": "123",
      "point_balance": 594
    },
    "point_value": 200
  }
}

ポイントの付与が正常に発生した上で、残高へ表示できない状況の場合は201エラーと共に以下の結果が表示されます。

{
  "data": {
    "id": "36ce8920-4a65-11eb-98c6-000c291828e7",
    "inserted_at": "2020-12-30T06:06:53.000000",
    "point_value": 200
  }
}