Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

API to get list of Available product for redemption.

Method :

Status
colourGreen
titlePost
/api/v1/redemption-products

Aura button
paramseyJocmVmIjoiaHR0cDovL2FwaS5kZXYubWliby5jbG91ZDo5Mi9zd2FnZ2VyL2luZGV4Lmh0bWwiLCJocmVmVHlwZSI6ImxpbmsiLCJocmVmVGFyZ2V0IjoiX2JsYW5rIiwiYmFja2dyb3VuZCI6IiMzNDQ1NjMiLCJjb2xvciI6IiNGRkZGRkYiLCJsYWJlbCI6IlRyeSBpdCBvdXQiLCJib3JkZXJSYWRpdXMiOiIyNCIsIm91dGxpbmVkIjoib3V0bGluZWQiLCJpY29uUG9zaXRpb24iOiJsZWZ0Iiwic2l6ZSI6Im1lZGl1bSIsImVsZXZhdGlvbiI6ImZsYXQiLCJhbGlnbm1lbnQiOiJsZWZ0In0=
Aura tab collection
paramseyJ0YWIiOjEsInNldHRpbmdzIjoie1wiZ2VuZXJhbFNldHRpbmdzXCI6e1widGFiU3BhY2luZ1wiOjAsXCJ0YWJXaWR0aFwiOjEwMCxcInRhYkhlaWdodFwiOjQ1LFwiZGlyZWN0aW9uXCI6XCJob3Jpem9udGFsXCJ9LFwiYWN0aXZlU2V0dGluZ3NcIjp7XCJiYWNrZ3JvdW5kQ29sb3JcIjp7XCJjb2xvclwiOlwiIzI2ODRmZmI4XCJ9LFwidGV4dFwiOntcImZvbnRTaXplXCI6MTYsXCJjb2xvclwiOlwiI2ZmZmZmZlwiLFwidGV4dEFsaWduXCI6XCJsZWZ0XCIsXCJmb250V2VpZ2h0XCI6XCJib2xkXCJ9fSxcImluYWN0aXZlU2V0dGluZ3NcIjp7XCJiYWNrZ3JvdW5kQ29sb3JcIjp7XCJjb2xvclwiOlwiI2ZmZmZmZlwifSxcInRleHRcIjp7XCJmb250U2l6ZVwiOjE2LFwiY29sb3JcIjpcIiM1ZTZjODRcIixcInRleHRBbGlnblwiOlwibGVmdFwiLFwiZm9udFdlaWdodFwiOlwibGlnaHRlclwifX0sXCJjb250ZW50U2V0dGluZ3NcIjp7XCJiYWNrZ3JvdW5kQ29sb3JcIjp7XCJjb2xvclwiOlwiI2ZmZlwifSxcInBhZGRpbmdcIjp7XCJ0b3BcIjoxMCxcInJpZ2h0XCI6MTAsXCJib3R0b21cIjoxMCxcImxlZnRcIjoxMH0sXCJib3JkZXJcIjp7XCJzdHlsZVwiOlwic29saWRcIixcIndpZHRoXCI6MixcInRvcFwiOnRydWUsXCJib3R0b21cIjp0cnVlLFwibGVmdFwiOnRydWUsXCJyaWdodFwiOnRydWUsXCJjb2xvclwiOlwiI2Y0ZjVmN1wifX0sXCJob3ZlclNldHRpbmdzXCI6e1wiYmFja2dyb3VuZENvbG9yXCI6e1wiY29sb3JcIjpcIiNmNGY1ZjdcIn0sXCJ0ZXh0XCI6e1wiZm9udFNpemVcIjoxNixcImNvbG9yXCI6XCIjNWU2Yzg0XCIsXCJ0ZXh0QWxpZ25cIjpcImxlZnRcIixcImZvbnRXZWlnaHRcIjpcImJvbGRcIn19fSJ9
Aura tab
paramseyJ0aXRsZSI6IlJlcXVlc3QgIn0=

Param

Required

Type

Default Value & Description

apiId

Y

string

apiKey

Y

string

pageNo

integer

Page no and page size are useful when there are many product available to redeem

pageSize

integer

Page no and page size are useful when there are many product available to redeem

Aura tab
paramseyJ0aXRsZSI6IkV4YW1wbGUgUmVxIn0=
Code Block
{
  "apiId": "d7bb1d04-8cbb-4b02-a252-555554fa8eeb",
  "apiKey": "K96fWH1zjZrI7tt1rBTEgP06Zs0laaMEW5f6h1Jmk1YgYwPMdbB865LxTvrwm+IJ"
}
Aura tab
paramseyJ0aXRsZSI6IlJlc3BvbnNlIn0=

Param

Type

Description

RedemptionProductData → List

categoryId

string($uuid)

categoryName

string

categoryDescription

string

productId


string($uuid)

productCode

productName

productDescription

redemptionLevel

Always 1

productType

Always 1

isAvailable

boolean

Identify availability of product redemption

isHot

boolean

Always false

thumbnailUrl

Thumbnail of Product

imageUrl

string

Image URL of product

availableStock

integer

null=Unlimited stock

redemptionOptions

redemptionOptionId

string($uuid)

redemptionType

Enum

1= Point

point

integer

Amount of Points required to redeem the product

Cash

number($double)

Amount of cash required to redeem the product,

Info

can be ignored if the value is 0

Aura tab
paramseyJ0aXRsZSI6IkV4YW1wbGUgUmVzcCJ9
json
paste-code-macro
language
[
    {
        "category": {
            "categoryId": "6fabc7ec-6e50-4b24-94bc-74c4ec49dddf",
            "categoryName": "Merchant",
            "categoryDescription": ""
        },
        "productId": "a3229e42-0d77-46e5-9756-071b31575310",
        "productCode": "Product 1 ",
        "productName": "Product 1 ",
        "productDescription": "Product 1 Desc",
        "redemptionLevel": 1,
        "productType": 1,
        "isAvailable": true,
        "isHot": false,
        "thumbnailUrl": "",
        "imageUrl": "http://backend.lsv4.dexperien.com:6789/images/index/7BA2A09D-C515-43F8-A475-8B1FD2100A5F",
        "availableStock": null,
        "startDate": "2021-07-13T16:33:34.847",
        "endDate": "2099-01-01T00:00:00",
        "merchantName": "MiboAPI",
        "voucherAmount": null,
        "redeemLimit": null,
        "voucherExpiryDate": null,
        "promotionTitle": null,
        "promotionDescription": null,
        "promotionImageUrl": "",
        "promotionVoucherUrl": null,
        "promotionVideoUrl": null,
        "promotionTerms": null,
        "redemptionOptions": [
            {
                "redemptionOptionId": "f7a983e3-3578-4547-96e5-8064736cab59",
                "redemptionType": 1,
                "point": 200,
                "cash": null
            }
        ]
    }
]

...