Add Product

Description

The /admin/addProduct endpoint is used to create a Product in VELA.

Request

Endpoint

/ui/v1/admin/addProduct

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 (Add)

{
    "id": 0,
    "productStatus": {
        "name": "ACTIVE"
    },
    "productType": {
        "name": "DEFAULT"
    },
    "productCategory": {
        "name": "INTERNAL_AND_EXTERNAL"
    },
    "costPerUnit": {
        "amount": "50.00",
        "currency": {
            "id": 1
        }
    },
    "merchantId": 20,
    "pointOfContactEmail": "recreation@email.com",
    "paymentAction": {
        "name": "PRE_AUTHORIZATION"
    },
    "restrictions": "",
    "useThisProductAsDefault": false,
    "productCode": "TEST-001",
    "productName": "Recreation",
    "productDescription": "Recreation",
    "createdUserId": "645"
}

Response

{
    "id": 263,
    "createdDateTime": null,
    "lastUpdatedDateTime": null,
    "lockedDateTime": null,
    "lockedByUserId": null,
    "createdUserId": 645,
    "lastModifiedUserId": null,
    "productCode": "TEST-001",
    "productName": "Recreation",
    "productDescription": "Recreation",
    "productStatus": {
        "name": "ACTIVE"
    },
    "productType": {
        "name": "DEFAULT"
    },
    "costPerUnit": {
        "amount": 50,
        "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": "recreation@email.com",
    "productCategory": {
        "name": "INTERNAL_AND_EXTERNAL"
    },
    "useThisProductAsDefault": false,
    "restrictions": "",
    "createdUserName": null,
    "message": {
        "code": "59",
        "type": {
            "name": "SUCCESS"
        },
        "include_i_icon": false,
        "description": "PRODUCT_CREATION_SUCCESS",
        "parameters": [
            {
                "name": "PRODUCT_NAME",
                "value": "Recreation"
            }
        ]
    },
    "merchantName": null,
    "sValidFromDateTime": null,
    "sValidToDateTime": null
}

Updated As Of Version 6.7.1.0