Product Summary
The productSummary API is used to fetch the products/services that are associated with the merchant.
Endpoint¶
/ui/v1/productSummaryMethod¶
POSTHeader¶
Content-Type: application/jsonBody¶
{
"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": "productCategory",
"name": "",
"searchable": true,
"orderable": true,
"search": {
"value": "",
"regex": false
}
},
{
"data": "costPerUnit",
"name": "",
"searchable": true,
"orderable": true,
"search": {
"value": "",
"regex": false
}
},
{
"data": "emailAddresses",
"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": "action",
"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": [
"20"
]
}
Response¶
{
"records": [
{
"id": 177,
"createdDateTime": 1690222679000,
"lastUpdatedDateTime": 1729864535000,
"lockedDateTime": null,
"lockedByUserId": null,
"createdUserId": 892,
"lastModifiedUserId": 645,
"productCode": "ABC001",
"productName": "Easy Check-in",
"productDescription": "Easy Check-in",
"productStatus": {
"name": "ACTIVE"
},
"productType": {
"name": "LODGING"
},
"costPerUnit": {
"amount": 300,
"currency": {
"id": 1,
"currencyCode": "USD",
"currencyText": "United States Dollar",
"currencySymbol": "$",
"fractionalUnit": "Cent",
"currencyExponent": "2",
"supportedByVisaCheckout": true,
"createdDateTime": 1754456477000,
"isoNumericCode": "840",
"isoCountryCode": "840",
"alpha2CountryCode": "US"
}
},
"validFromDateTime": null,
"validToDateTime": null,
"productInfoUrl": null,
"productImageUrl": null,
"channelId": null,
"merchantId": 20,
"minQuantity": 1,
"maxQuantity": 1,
"paymentAction": {
"name": "PRE_AUTHORIZATION"
},
"pointOfContactEmail": "",
"productCategory": {
"name": "INTERNAL_AND_EXTERNAL"
},
"useThisProductAsDefault": true,
"restrictions": null,
"createdUserName": null,
"message": null,
"merchantName": "ABC Company",
"sValidFromDateTime": null,
"sValidToDateTime": null
},
{
"id": 181,
"createdDateTime": 1699546210000,
"lastUpdatedDateTime": 1729864535000,
"lockedDateTime": null,
"lockedByUserId": null,
"createdUserId": 645,
"lastModifiedUserId": null,
"productCode": "ABC003",
"productName": "Spa",
"productDescription": "Spa",
"productStatus": {
"name": "ACTIVE"
},
"productType": {
"name": "DEFAULT"
},
"costPerUnit": {
"amount": 150,
"currency": {
"id": 1,
"currencyCode": "USD",
"currencyText": "United States Dollar",
"currencySymbol": "$",
"fractionalUnit": "Cent",
"currencyExponent": "2",
"supportedByVisaCheckout": true,
"createdDateTime": 1754456477000,
"isoNumericCode": "840",
"isoCountryCode": "840",
"alpha2CountryCode": "US"
}
},
"validFromDateTime": null,
"validToDateTime": null,
"productInfoUrl": null,
"productImageUrl": null,
"channelId": null,
"merchantId": 20,
"minQuantity": 1,
"maxQuantity": 1,
"paymentAction": {
"name": "SALE"
},
"pointOfContactEmail": "abc@abc.com",
"productCategory": {
"name": "INTERNAL_AND_EXTERNAL"
},
"useThisProductAsDefault": false,
"restrictions": null,
"createdUserName": "madmin.abc",
"message": null,
"merchantName": "ABC Company",
"sValidFromDateTime": null,
"sValidToDateTime": null
},
{
"id": 178,
"createdDateTime": 1690222719000,
"lastUpdatedDateTime": 1713330076000,
"lockedDateTime": null,
"lockedByUserId": null,
"createdUserId": 892,
"lastModifiedUserId": 645,
"productCode": "ABC002",
"productName": "Miscellaneous",
"productDescription": "Miscellaneous",
"productStatus": {
"name": "ACTIVE"
},
"productType": {
"name": "DEFAULT"
},
"costPerUnit": {
"amount": null,
"currency": {
"id": 1,
"currencyCode": "USD",
"currencyText": "United States Dollar",
"currencySymbol": "$",
"fractionalUnit": "Cent",
"currencyExponent": "2",
"supportedByVisaCheckout": true,
"createdDateTime": 1754456477000,
"isoNumericCode": "840",
"isoCountryCode": "840",
"alpha2CountryCode": "US"
}
},
"validFromDateTime": null,
"validToDateTime": null,
"productInfoUrl": null,
"productImageUrl": null,
"channelId": null,
"merchantId": 20,
"minQuantity": 1,
"maxQuantity": 1,
"paymentAction": {
"name": "SALE"
},
"pointOfContactEmail": "",
"productCategory": {
"name": "INTERNAL_AND_EXTERNAL"
},
"useThisProductAsDefault": false,
"restrictions": null,
"createdUserName": null,
"message": null,
"merchantName": "ABC Company",
"sValidFromDateTime": null,
"sValidToDateTime": null
}
],
"recordCount": 3,
"message": null
}
Updated As Of Version 6.7.1.0