Set Product As Default

Description

The setProductAsDefault API is used to set a Product/Service as the default option in VELA.

Request

Endpoint

/ui/v1/setProductAsDefault

Method

POST

Content-Type: application/json
Authorization: $TOKEN

Note

Replace $TOKEN in the request with the base64-encoded username/password combination in the format username:password.

Given a username of username and a password of password, the request header would appear as follows:

Content-Type: application/json
Authorization: dXNlcm5hbWU6cGFzc3dvcmQ=

Request Body

{
    "id": 110,
    "createdDateTime": 1627401629000,
    "lastUpdatedDateTime": 1703810789000,
    "lockedDateTime": null,
    "lockedByUserId": null,
    "createdUserId": 586,
    "lastModifiedUserId": 861,
    "productCode": "PUNC001",
    "productName": "Easy Check-in",
    "productDescription": null,
    "productStatus": {
        "name": "ACTIVE"
    },
    "productType": {
        "name": "DEFAULT"
    },
    "costPerUnit": {
        "amount": 17150,
        "currency": {
            "id": 1,
            "currencyCode": "USD",
            "currencyText": "United States Dollar",
            "currencySymbol": "$",
            "fractionalUnit": "Cent",
            "numOfDecimalPlaces": "2",
            "supportedByVisaCheckout": true,
            "createdDateTime": 1608260908000,
            "isoNumericCode": "840",
            "isoCountryCode": "840"
        }
    },
    "validFromDateTime": null,
    "validToDateTime": null,
    "productInfoUrl": null,
    "productImageUrl": null,
    "channelId": null,
    "merchantId": 11,
    "minQuantity": null,
    "maxQuantity": null,
    "paymentAction": {
        "name": "PRE_AUTHORIZATION"
    },
    "pointOfContactEmail": "",
    "productCategory": {
        "name": "INTERNAL_AND_EXTERNAL"
    },
    "useThisProductAsDefault": false,
    "createdUserName": "Fiserv.eCommerce",
    "message": null,
    "merchantName": "Club Med  Punta Cana",
    "sValidFromDateTime": null,
    "sValidToDateTime": null
}

Response

{
    "id": 110,
    "createdDateTime": 1627401629000,
    "lastUpdatedDateTime": 1703810789000,
    "lockedDateTime": null,
    "lockedByUserId": null,
    "createdUserId": 586,
    "lastModifiedUserId": 861,
    "productCode": "PUNC001",
    "productName": "Easy Check-in",
    "productDescription": null,
    "productStatus": {
        "name": "ACTIVE"
    },
    "productType": {
        "name": "DEFAULT"
    },
    "costPerUnit": {
        "amount": 17150,
        "currency": {
            "id": 1,
            "currencyCode": "USD",
            "currencyText": "United States Dollar",
            "currencySymbol": "$",
            "fractionalUnit": "Cent",
            "numOfDecimalPlaces": "2",
            "supportedByVisaCheckout": true,
            "createdDateTime": 1608260908000,
            "isoNumericCode": "840",
            "isoCountryCode": "840"
        }
    },
    "validFromDateTime": null,
    "validToDateTime": null,
    "productInfoUrl": null,
    "productImageUrl": null,
    "channelId": null,
    "merchantId": 11,
    "minQuantity": null,
    "maxQuantity": null,
    "paymentAction": {
        "name": "PRE_AUTHORIZATION"
    },
    "pointOfContactEmail": "",
    "productCategory": {
        "name": "INTERNAL_AND_EXTERNAL"
    },
    "useThisProductAsDefault": false,
    "createdUserName": "Fiserv.eCommerce",
    "message": {
        "code": "152",
        "type": {
            "name": "SUCCESS"
        },
        "include_i_icon": false,
        "description": "PRODUCT_SET_DEFAULT_SUCCESS",
        "parameters": [
            {
                "name": "PRODUCT_NAME",
                "value": "Easy Check-in"
            }
        ]
    },
    "merchantName": "Club Med  Punta Cana",
    "sValidFromDateTime": null,
    "sValidToDateTime": null
}

Updated As Of Version 6.1.1