REST API

API

Get total customer point

Endpoint: /V1/lof-rewardpoints/customer/:customer

Method: GET

Params:

  • customer

Response Data:

"string"

Get Order Earn Spent point

Endpoint: V1/lof-rewardpoints/order

Method: GET

Params:

  • order_id

Response Data:

"string"

Get Total Spent Point

Endpoint: /V1/lof-rewardpoints/spend-point

Method: GET

Params:

  • cartId

Response Data:

"string"

Customer logged In API

Edit Set Point

Endpoint: /V1/carts/mine/point

Method: PUT

Params:

{
  "cartId": 0
}

Response Data:

true

Apply Point

Endpoint: /V1/carts/applypoint/:cartId/:spendPoint/:spendingRuleId

Method: POST

Params:

  • cartId

  • spendPoint

  • spendingRuleId

Response Data:

"string"

Get My List Reward point

Endpoint: /V1/lof-rewardpoints/mine/transactions

Method: GET

Params:

Response Data:

{
  "items": [
    {
      "transaction_id": 0,
      "customer_id": 0,
      "quote_id": 0,
      "amount": 0,
      "amount_used": 0,
      "title": "string",
      "code": "string",
      "action": "string",
      "status": "string",
      "params": "string",
      "is_expiration_email_sent": 0,
      "email_message": "string",
      "apply_at": "string",
      "is_applied": 0,
      "is_expired": 0,
      "expires_at": "string",
      "updated_at": "string",
      "created_at": "string",
      "store_id": 0,
      "admin_user_id": 0
    }
  ],
  "search_criteria": {
    "filter_groups": [
      {
        "filters": [
          {
            "field": "string",
            "value": "string",
            "condition_type": "string"
          }
        ]
      }
    ],
    "sort_orders": [
      {
        "field": "string",
        "direction": "string"
      }
    ],
    "page_size": 0,
    "current_page": 0
  },
  "total_count": 0
}

Get My Transaction By Id

Endpoint: /V1/lof-rewardpoints/mine/transaction/:transactionId

Method: GET

Params:

  • customerId

  • transactionId

Response Data:

{
  "transaction_id": 0,
  "customer_id": 0,
  "quote_id": 0,
  "amount": 0,
  "amount_used": 0,
  "title": "string",
  "code": "string",
  "action": "string",
  "status": "string",
  "params": "string",
  "is_expiration_email_sent": 0,
  "email_message": "string",
  "apply_at": "string",
  "is_applied": 0,
  "is_expired": 0,
  "expires_at": "string",
  "updated_at": "string",
  "created_at": "string",
  "store_id": 0,
  "admin_user_id": 0
}

Apply Code

Endpoint: /V1/lof-rewardpoints/mine/applyCode/:code/:storeId

Method: GET

Params:

  • code

  • storeId

  • customerId

Response Data:

true

Backend API

Get List Reward Point

Endpoint: /V1/lof-rewardpoints/transactions

Method: GET

Params:

Response Data:

{
  "items": [
    {
      "transaction_id": 0,
      "customer_id": 0,
      "quote_id": 0,
      "amount": 0,
      "amount_used": 0,
      "title": "string",
      "code": "string",
      "action": "string",
      "status": "string",
      "params": "string",
      "is_expiration_email_sent": 0,
      "email_message": "string",
      "apply_at": "string",
      "is_applied": 0,
      "is_expired": 0,
      "expires_at": "string",
      "updated_at": "string",
      "created_at": "string",
      "store_id": 0,
      "admin_user_id": 0
    }
  ],
  "search_criteria": {
    "filter_groups": [
      {
        "filters": [
          {
            "field": "string",
            "value": "string",
            "condition_type": "string"
          }
        ]
      }
    ],
    "sort_orders": [
      {
        "field": "string",
        "direction": "string"
      }
    ],
    "page_size": 0,
    "current_page": 0
  },
  "total_count": 0
}

Get Reward Point By Id

Endpoint: /V1/lof-rewardpoints/transaction/:transactionId

Method: GET

Params:

  • transactionId

Response Data:

{
  "transaction_id": 0,
  "customer_id": 0,
  "quote_id": 0,
  "amount": 0,
  "amount_used": 0,
  "title": "string",
  "code": "string",
  "action": "string",
  "status": "string",
  "params": "string",
  "is_expiration_email_sent": 0,
  "email_message": "string",
  "apply_at": "string",
  "is_applied": 0,
  "is_expired": 0,
  "expires_at": "string",
  "updated_at": "string",
  "created_at": "string",
  "store_id": 0,
  "admin_user_id": 0
}

Cancel Reward Point by Id

Endpoint: /V1/lof-rewardpoints/canceltransaction/:transactionId

Method: GET

Params:

  • transactionId

Response Data:

true

Edit Reward Point

Endpoint: /V1/lof-rewardpoints/transaction

Method: PUT

Params:

{
  "transaction": {
    "transaction_id": 0,
    "customer_id": 0,
    "quote_id": 0,
    "amount": 0,
    "amount_used": 0,
    "title": "string",
    "code": "string",
    "action": "string",
    "status": "string",
    "params": "string",
    "is_expiration_email_sent": 0,
    "email_message": "string",
    "apply_at": "string",
    "is_applied": 0,
    "is_expired": 0,
    "expires_at": "string",
    "updated_at": "string",
    "created_at": "string",
    "store_id": 0,
    "admin_user_id": 0
  }
}

Response Data:

{
  "transaction_id": 0,
  "customer_id": 0,
  "quote_id": 0,
  "amount": 0,
  "amount_used": 0,
  "title": "string",
  "code": "string",
  "action": "string",
  "status": "string",
  "params": "string",
  "is_expiration_email_sent": 0,
  "email_message": "string",
  "apply_at": "string",
  "is_applied": 0,
  "is_expired": 0,
  "expires_at": "string",
  "updated_at": "string",
  "created_at": "string",
  "store_id": 0,
  "admin_user_id": 0
}

Delete Reward Point

Endpoint: /V1/lof-rewardpoints/transaction/:transactionId

Method: DELETE

Params:

  • transactionId

Response Data:

true

Get List Redeem Code

Endpoint: /V1/lof-rewardpoints/redeemcodes

Method: GET

Params:

Response Data:

{
  "items": [
    {
      "code_id": "string",
      "code_prefix": "string",
      "code": "string",
      "earn_points": "string",
      "uses_per_code": "string",
      "store_id": "string",
      "active_from": "string",
      "active_to": "string",
      "code_used": "string"
    }
  ],
  "search_criteria": {
    "filter_groups": [
      {
        "filters": [
          {
            "field": "string",
            "value": "string",
            "condition_type": "string"
          }
        ]
      }
    ],
    "sort_orders": [
      {
        "field": "string",
        "direction": "string"
      }
    ],
    "page_size": 0,
    "current_page": 0
  },
  "total_count": 0
}

Get List Redeem Code By Id

Endpoint: /V1/lof-rewardpoints/redeemcode/:redeemId

Method: GET

Params:

  • redeemId

Response Data:

{
  "code_id": "string",
  "code_prefix": "string",
  "code": "string",
  "earn_points": "string",
  "uses_per_code": "string",
  "store_id": "string",
  "active_from": "string",
  "active_to": "string",
  "code_used": "string"
}

Edit Redeem Code

Endpoint: /V1/lof-rewardpoints/redeemcode

Method: PUT

Params:

{
  "redeem": {
    "code_id": "string",
    "code_prefix": "string",
    "code": "string",
    "earn_points": "string",
    "uses_per_code": "string",
    "store_id": "string",
    "active_from": "string",
    "active_to": "string",
    "code_used": "string"
  }
}

Response Data:

Delete Redeem Code

Endpoint:/V1/lof-rewardpoints/redeemcode/:redeemId

Method: DELETE

Params:

  • redeemId

Response Data:

true

Last updated