Skip to main content

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.

​
⚠️ Important:

  1. This API must be implemented and hosted by the client.
  2. Xoxoday will consume this API whenever a redemption takes place.
  3. The request and response below are provided only as a sample to illustrate the structure that Xoxoday expects.
  4. Please ensure that your response is always in JSON format only, as our system does not support any other data types.

​
Sample Request and Response

​
Headers

  1. application/JSON

​
Sample Request

JSON (POST)
{
  "unique_id": "TTEO32S99ERCL",
  "auth_token": "0fe121f67cb0b90ef39fd83380bf1e12310912c86f4d7d5bfed3f3198e531b4f8d8af179b68361da28d0bc0353ce45ac7c374aa9c51dfb54c6705571f5ab8fe8",
  "total_points_redeemed": 348.5,
  "order_id": "AB1890082790",
  "order_date": 1693995688,
  "orderData": [
    {
      "quantity": 1,
      "orderAmount": 10,
      "product": {
        "productId": "28811",
        "name": "Sony MDR-ZX110AP Wired On-Ear Headphones with tangle free cable",
        "category": "merchandise",
        "price": 10
      }
    },
    {
      "quantity": 1,
      "orderAmount": 337.5,
      "product": {
        "productId": "28628",
        "name": "Flipkart Rs.250 Gift Card",
        "category": "giftcard",
        "price": 337.5
      }
    }
  ]
}

​
Sample Request Schema

ParameterTypeRequirementDescription
unique_idString (email / phone)RequiredUnique identifier for the user so that points are updated to the correct account.
auth_tokenStringRequiredAuthorization value to allow the request from Xoxoday. Can be hash, Basic Auth, Bearer token, etc.
total_points_redeemedInteger / FloatRequiredTotal number of redeemed points.
order_idString / IntegerRequiredUnique Order ID that helps track the transaction.
order_dateInteger (epoch)OptionalEpoch timestamp of when the order was placed.
orderDataArrayOptionalList of redeemed items, with product details (ID, name, category, price, quantity, and orderAmount).
orderData[].productObjectOptionalContains details of the product being redeemed.

​
Sample Response

{
  "status": "1",
  "message": "Successfully updated",
  "data": {
    "order_id": "12345"
  }
}

​
Sample Response Schema

ParametersDescription
status1 = success / 0 = failure
messageIndicates the APIs success/failure
order_idOrder ID of the item(s) ordered by the user

​
Implementation Notes

  1. Xoxoday will only consume this API — the client must build and expose it.
  2. The auth_token must be provided by you under tpdobject when SSO Redirection API is called .
  3. Make sure the API response includes accurate response status.