Create vendor redemption

Vendor Redemption refers to a process or transaction where customers redeem rewards through a vendor or third-party service provider.
This API is used to create a vendor redemption for the organization. You can use this API to define the redemption type and the details for how the customer will exchange the redemption.
Example: A Customer wants to exchange loyalty points for a value of INR 100. You can pass the cash amount to INR 100 using the vendor API.

👍

Note

  • For detailed information about our APIs and for hands-on testing, refer documentation in API overview and step-by-step guide on making your first API call in Make your first API call .

Prerequisites

  • Authentication: Basic or OAuth authentication
  • Default access group

Resource information

URIapi_gateway/rewards/core/v1/vendor/redemption/create
HTTP MethodPOST
PaginationNo
Batch supportNo
Rate limit informationNone

API endpoint example

https://eucrm.cc.capillarytech.com/api_gateway/rewards/core/v1/vendor/redemption/create

Request body parameters

ParameterData TypeDescription
brandId*IntegerUnique ID of the brand.
vendorId*StringUnique ID of the vendor.
name*StringName defined by the brand for the vendor reward.
redemptionType*EnumSpecifies the method by which the customer can redeem rewards.

Supported values: GAMES, AUCTION, CART_PROMOTION, CASH_WALLET, VENDOR_ONLY_REWARD, VOUCHER, CASH_BACK, INTOUCH_REWARD, PHYSICAL_REWARD, CHARITY, MILES, GIFT_CARD, SWEEPSTAKES, VENDOR_INTOUCH_REWARD, CARD_DISC.
VENDOR_ONLY_REWARD: These are either points or coupons created at the vendor end.
VENDOR_INTOUCH_REWARD: These are vendor rewards created at the Capillary end.
It is not recommended to use the Vendor Intouch reward redemption type. Instead, you can use the Vendor only reward redemption type to issue coupons directly through the vendor API. You can find more information here.
For example, "MILES" indicates that the customer can use miles accumulated through the loyalty program for redemption against payment or points.
actionObjectSpecifies the endpoint URL and the api body of the internal API that executes a specific action.
For example, "apiUrl": "https://crm-nightly-new.cc.capillarytech.com/v1.1/request/add?program_id=2851" specifies the endpoint where the request to add goodwill points will be made.
nameStringThe name of the action to be executed.
execOrderIntegerThe execution order of the action.
apiUrlStringThe URL to which the API request is made. This defines the internal API URL.
apiTypeStringThe HTTP method to be used for the API request.
apiHeadersObjectAn object containing the headers to be sent with the API request.
acceptStringThe accept header indicating the expected response format .
Content-TypeStringThe content type header indicating the format of the request body.
AuthorizationStringThe authorization header containing the authentication credentials.
apiBodyStringThe JSON-formatted string representing the body of the API request.
rootObjectThe root object of the JSON body.
requestArray of ObjectsAn array of request objects.
customerObjectAn object containing customer details.
mobileStringThe mobile number of the customer.
commentsStringComments or notes related to the API service request.
reasonStringThe reason for issuing goodwill points.
typeStringThe type of the request.
base_typeStringThe base type of the points.
pointsStringThe number of points to be awarded.
contextKeysObjectAn object containing context keys for extracting values from the response.
voucherStringThe context key for extracting the voucher ID from the response.

{
    "brandId": 47,
    "vendorId": 138,
    "name": "Miles",
    "redemptionType": "MILES",
    "actions": [
        {
            "name": "add good will points",
            "execOrder": 1,
            "apiUrl": "https://crm-nightly-new.cc.capillarytech.com/v1.1/request/add?program_id=2851",
            "apiType": "POST",
            "apiHeaders": {
                "accept": "application/json",
                "Content-Type": "application/json",
                "Authorization": "Basic bHVjaWF1dG9fdGlsbF8xMDoyMDJjYjk2MmFjNTkwNzViOTY0YjA3MTUyZDIzNGI3MA=="
            },
            "apiBody": "{\"root\":{\"request\":[{\"customer\":{\"mobile\":\"${mobile}\"},\"comments\":\"APIServicerequest-Awarding200points.\",\"reason\":\"IssueGoodwillpoints\",\"type\":\"GOODWILL\",\"base_type\":\"POINTS\",\"points\":\"${redemptionValue}\"}]}}",
            "contextKeys": {
                "voucher": "response.requests.request.get(0).id"
            }
        }
    ],
    "responseKeys": [
        "voucher"
    ]
}

Response parameters

ParameterDatatypeDescription
successBooleanIndicates whether the API call was successful or not.
codeIntegerThe code associated with the response.
messageStringA message providing details about the response.
idIntegerThe unique identifier for the redemption object.
nameStringThe name associated with the redemption object.
redemptionTypeEnumThe type of redemption.
enabledBooleanIndicates whether the redemption is currently enabled.
lastUpdatedOnNullThe last update timestamp of the redemption object.
actionCountIntegerThe count of the number of redemptions.
{
    "status": {
        "success": true,
        "code": 5012,
        "message": "Vendor redemption created successfully"
    },
    "redemption": {
        "id": 5666,
        "name": "Miles",
        "redemptionType": "MILES",
        "enabled": true,
        "lastUpdatedOn": null,
        "actionCount": 1
    }
}
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!