Skip to main content
POST
/
fetchPoints
Fetch Points API
curl --request POST \
  --url https://stagingstores.xoxoday.com/chef/v1/oauth/api/fetchPoints \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "storesAdmin.query.user_balance",
  "tag": "storeAdmin",
  "variables": {
    "user_data": {
      "email": "your.email@example.com",
      "phone": "+91-8999888887"
    }
  }
}
'
{
  "data": {
    "user_balance": {
      "success": 1,
      "message": null,
      "data": {
        "total": 1500
      }
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://help-plum.xoxoday.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Fetch Points API Schema

PropertyTypeDescription
user_data.emailStringUser’s email ID to fetch balance.
user_data.phoneStringUser’s phone number to fetch balance.

​
Response Schema

PathTypeDescription
dataobjectRoot response object.
data.user_balanceobjectContainer for user points/balance data.
data.user_balance.successnumberAPI execution status (1 = success).
data.user_balance.messagestring/nullAPI message (null when no message is returned).
data.user_balance.dataobjectActual points data.
data.user_balance.data.totalnumberTotal available reward points for the user.

Authorizations

​
Authorization
string
header
required

Authorization: Bearer <access_token>

Body

application/json
​
query
enum<string>
default:storesAdmin.query.user_balance
required

Always use storesAdmin.query.user_balance.

Available options:
storesAdmin.query.user_balance
​
tag
enum<string>
default:storeAdmin
required

Always use storeAdmin.

Available options:
storeAdmin
​
variables
object
required

Response

User points balance returned successfully.

​
data
object