Manage Products/Services

Description

The productSummary endpoint is userd to fetch the existing Products/Services information.

Request

Endpoint

    /ui/v1/productSummary

Method

    POST

Header

Content-Type: application/json

Request Body

{
    "draw": 1,
    "columns": [{
        "data": "",
        "name": "",
        "searchable": true,
        "orderable": true,
        "search": {
            "value": "",
            "regex": false
        }
    }, {
        "data": "productCode",
        "name": "",
        "searchable": true,
        "orderable": true,
        "search": {
            "value": "",
            "regex": false
        }
    }, {
        "data": "productName",
        "name": "",
        "searchable": true,
        "orderable": true,
        "search": {
            "value": "",
            "regex": false
        }
    }, {
        "data": "productDescription",
        "name": "",
        "searchable": true,
        "orderable": true,
        "search": {
            "value": "",
            "regex": false
        }
    }, {
        "data": "productType",
        "name": "",
        "searchable": true,
        "orderable": true,
        "search": {
            "value": "",
            "regex": false
        }
    }, {
        "data": "costPerUnit.amount",
        "name": "",
        "searchable": true,
        "orderable": true,
        "search": {
            "value": "",
            "regex": false
        }
    }, {
        "data": "pointOfContactEmail",
        "name": "",
        "searchable": true,
        "orderable": true,
        "search": {
            "value": "",
            "regex": false
        }
    }, {
        "data": "useThisProductAsDefault",
        "name": "",
        "searchable": true,
        "orderable": true,
        "search": {
            "value": "",
            "regex": false
        }
    }, {
        "data": "productStatus",
        "name": "",
        "searchable": true,
        "orderable": true,
        "search": {
            "value": "",
            "regex": false
        }
    }, {
        "data": "id",
        "name": "",
        "searchable": true,
        "orderable": false,
        "search": {
            "value": "",
            "regex": false
        }
    }, {
        "data": "validFromDateTime",
        "name": "",
        "searchable": true,
        "orderable": true,
        "search": {
            "value": "",
            "regex": false
        }
    }, {
        "data": "validToDateTime",
        "name": "",
        "searchable": true,
        "orderable": true,
        "search": {
            "value": "",
            "regex": false
        }
    }, {
        "data": "createdUserName",
        "name": "",
        "searchable": true,
        "orderable": false,
        "search": {
            "value": "",
            "regex": false
        }
    }],
    "order": [{
        "column": 0,
        "dir": "asc"
    }],
    "start": 0,
    "length": 200,
    "search": {
        "value": "",
        "regex": false
    },
    "searchString": "",
    "merchantId": ["21"]
}

Response

{
    "records": [{
            "id": 101,
            "createdDateTime": 1614959258000,
            "lastUpdatedDateTime": 1657298156000,
            "lockedDateTime": null,
            "lockedByUserId": null,
            "createdUserId": 665,
            "lastModifiedUserId": 932,
            "productCode": "Colu001",
            "productName": "Easy Check-in",
            "productDescription": "Easy Check-in",
            "productStatus": {
                "name": "ACTIVE"
            },
            "productType": {
                "name": "DEFAULT"
            },
            "costPerUnit": {
                "amount": 310.000,
                "currency": {
                    "id": 12,
                    "currencyCode": "BSD",
                    "currencyText": "Bahamian Dollar",
                    "currencySymbol": "$",
                    "fractionalUnit": "Cent",
                    "numOfDecimalPlaces": "2",
                    "supportedByVisaCheckout": false,
                    "createdDateTime": 1608260908000,
                    "isoNumericCode": "044",
                    "isoCountryCode": "044"
                }
            },
            "validFromDateTime": null,
            "validToDateTime": null,
            "productInfoUrl": null,
            "productImageUrl": null,
            "channelId": null,
            "merchantId": 21,
            "minQuantity": null,
            "maxQuantity": null,
            "paymentAction": {
                "name": "PRE_AUTHORIZATION"
            },
            "pointOfContactEmail": "",
            "productCategory": {
                "name": "INTERNAL_AND_EXTERNAL"
            },
            "useThisProductAsDefault": true,
            "createdUserName": "merchantadmin.columbus",
            "message": null,
            "merchantName": "Vela Columbus Isle",
            "sValidFromDateTime": null,
            "sValidToDateTime": null
        },
        {
            "id": 169,
            "createdDateTime": 1665514043000,
            "lastUpdatedDateTime": null,
            "lockedDateTime": null,
            "lockedByUserId": null,
            "createdUserId": 665,
            "lastModifiedUserId": 932,
            "productCode": "COLU003",
            "productName": "SPA",
            "productDescription": "SPA",
            "productStatus": {
                "name": "DELETED"
            },
            "productType": {
                "name": "SERVICE"
            },
            "costPerUnit": {
                "amount": null,
                "currency": {
                    "id": 12,
                    "currencyCode": "BSD",
                    "currencyText": "Bahamian Dollar",
                    "currencySymbol": "$",
                    "fractionalUnit": "Cent",
                    "numOfDecimalPlaces": "2",
                    "supportedByVisaCheckout": false,
                    "createdDateTime": 1608260908000,
                    "isoNumericCode": "044",
                    "isoCountryCode": "044"
                }
            },
            "validFromDateTime": null,
            "validToDateTime": null,
            "productInfoUrl": null,
            "productImageUrl": null,
            "channelId": null,
            "merchantId": 21,
            "minQuantity": null,
            "maxQuantity": null,
            "paymentAction": {
                "name": "SALE"
            },
            "pointOfContactEmail": "vela@datumsoftware.com",
            "productCategory": {
                "name": "INTERNAL_AND_EXTERNAL"
            },
            "useThisProductAsDefault": false,
            "createdUserName": "merchantadmin.columbus",
            "message": null,
            "merchantName": "Vela Columbus Isle",
            "sValidFromDateTime": null,
            "sValidToDateTime": null
        },
        {
            "id": 172,
            "createdDateTime": 1666019795000,
            "lastUpdatedDateTime": null,
            "lockedDateTime": null,
            "lockedByUserId": null,
            "createdUserId": 932,
            "lastModifiedUserId": 932,
            "productCode": "COLC006",
            "productName": "Parking",
            "productDescription": "Parking",
            "productStatus": {
                "name": "ACTIVE"
            },
            "productType": {
                "name": "DEFAULT"
            },
            "costPerUnit": {
                "amount": 20.000,
                "currency": {
                    "id": 12,
                    "currencyCode": "BSD",
                    "currencyText": "Bahamian Dollar",
                    "currencySymbol": "$",
                    "fractionalUnit": "Cent",
                    "numOfDecimalPlaces": "2",
                    "supportedByVisaCheckout": false,
                    "createdDateTime": 1608260908000,
                    "isoNumericCode": "044",
                    "isoCountryCode": "044"
                }
            },
            "validFromDateTime": null,
            "validToDateTime": null,
            "productInfoUrl": null,
            "productImageUrl": null,
            "channelId": null,
            "merchantId": 21,
            "minQuantity": null,
            "maxQuantity": null,
            "paymentAction": {
                "name": "SALE"
            },
            "pointOfContactEmail": "",
            "productCategory": {
                "name": "INTERNAL_AND_EXTERNAL"
            },
            "useThisProductAsDefault": false,
            "createdUserName": "harsha.akk",
            "message": null,
            "merchantName": "Vela Columbus Isle",
            "sValidFromDateTime": null,
            "sValidToDateTime": null
        },
        {
            "id": 161,
            "createdDateTime": 1657298144000,
            "lastUpdatedDateTime": null,
            "lockedDateTime": null,
            "lockedByUserId": null,
            "createdUserId": 787,
            "lastModifiedUserId": null,
            "productCode": "COLU002",
            "productName": "Miscellaneous",
            "productDescription": "Miscellaneous",
            "productStatus": {
                "name": "ACTIVE"
            },
            "productType": {
                "name": "DEFAULT"
            },
            "costPerUnit": {
                "amount": null,
                "currency": {
                    "id": 12,
                    "currencyCode": "BSD",
                    "currencyText": "Bahamian Dollar",
                    "currencySymbol": "$",
                    "fractionalUnit": "Cent",
                    "numOfDecimalPlaces": "2",
                    "supportedByVisaCheckout": false,
                    "createdDateTime": 1608260908000,
                    "isoNumericCode": "044",
                    "isoCountryCode": "044"
                }
            },
            "validFromDateTime": null,
            "validToDateTime": null,
            "productInfoUrl": null,
            "productImageUrl": null,
            "channelId": null,
            "merchantId": 21,
            "minQuantity": null,
            "maxQuantity": null,
            "paymentAction": {
                "name": "SALE"
            },
            "pointOfContactEmail": "",
            "productCategory": {
                "name": "INTERNAL_AND_EXTERNAL"
            },
            "useThisProductAsDefault": false,
            "createdUserName": "madmin.bahamas",
            "message": null,
            "merchantName": "Vela Columbus Isle",
            "sValidFromDateTime": null,
            "sValidToDateTime": null
        },
        {
            "id": 170,
            "createdDateTime": 1665514070000,
            "lastUpdatedDateTime": null,
            "lockedDateTime": null,
            "lockedByUserId": null,
            "createdUserId": 665,
            "lastModifiedUserId": null,
            "productCode": "COLU004",
            "productName": "Excursion",
            "productDescription": "Excursion",
            "productStatus": {
                "name": "ACTIVE"
            },
            "productType": {
                "name": "DEFAULT"
            },
            "costPerUnit": {
                "amount": null,
                "currency": {
                    "id": 12,
                    "currencyCode": "BSD",
                    "currencyText": "Bahamian Dollar",
                    "currencySymbol": "$",
                    "fractionalUnit": "Cent",
                    "numOfDecimalPlaces": "2",
                    "supportedByVisaCheckout": false,
                    "createdDateTime": 1608260908000,
                    "isoNumericCode": "044",
                    "isoCountryCode": "044"
                }
            },
            "validFromDateTime": null,
            "validToDateTime": null,
            "productInfoUrl": null,
            "productImageUrl": null,
            "channelId": null,
            "merchantId": 21,
            "minQuantity": null,
            "maxQuantity": null,
            "paymentAction": {
                "name": "SALE"
            },
            "pointOfContactEmail": "vela@datusmoftware.com",
            "productCategory": {
                "name": "INTERNAL_AND_EXTERNAL"
            },
            "useThisProductAsDefault": false,
            "createdUserName": "merchantadmin.columbus",
            "message": null,
            "merchantName": "Vela Columbus Isle",
            "sValidFromDateTime": null,
            "sValidToDateTime": null
        },
        {
            "id": 174,
            "createdDateTime": 1668183072000,
            "lastUpdatedDateTime": null,
            "lockedDateTime": null,
            "lockedByUserId": null,
            "createdUserId": 929,
            "lastModifiedUserId": null,
            "productCode": "COLC009",
            "productName": "Boutique",
            "productDescription": null,
            "productStatus": {
                "name": "ACTIVE"
            },
            "productType": {
                "name": "DEFAULT"
            },
            "costPerUnit": {
                "amount": 10.000,
                "currency": {
                    "id": 1,
                    "currencyCode": "USD",
                    "currencyText": "United States Dollar",
                    "currencySymbol": "$",
                    "fractionalUnit": "Cent",
                    "numOfDecimalPlaces": "2",
                    "supportedByVisaCheckout": true,
                    "createdDateTime": 1608260908000,
                    "isoNumericCode": "840",
                    "isoCountryCode": "840"
                }
            },
            "validFromDateTime": 1668142800000,
            "validToDateTime": 1669784400000,
            "productInfoUrl": null,
            "productImageUrl": null,
            "channelId": null,
            "merchantId": 21,
            "minQuantity": 1,
            "maxQuantity": 10,
            "paymentAction": {
                "name": "SALE"
            },
            "pointOfContactEmail": "",
            "productCategory": {
                "name": "INTERNAL_AND_EXTERNAL"
            },
            "useThisProductAsDefault": false,
            "createdUserName": "madmin.columbus",
            "message": null,
            "merchantName": "Vela Columbus Isle",
            "sValidFromDateTime": null,
            "sValidToDateTime": null
        }
    ],
    "recordCount": 6,
    "message": null
}

Updated As Of Version 5.9.0.7