Get Product/Service

Description

The getProduct endpoint is used to retrieve a Product/Service details for a given user.

Request

Endpoint

/ui/v1/getProduct/id

Note

Replace id above with the internal ID of the Product.

Method

GET

Response

 {
    "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": null,
    "message": null,
    "merchantName": null,
    "sValidFromDateTime": null,
    "sValidToDateTime": null
}

Updated As of Version 5.9.0.7