Skip to navigation

Add New Product

View as Markdown

Add New Product

This APIs endpoint allows you to add a new product to the Dice. The request should be sent as an HTTP POST to hostName/apis/external/product/addProduct.

Request Body

ParamsRequiredTypeDescription
idOptionalstringThe ID of the product.
glOptionalstringThe GL code of the product.
titleMandatorystringThe title or name of the product.
desMandatorystringThe description of the product.
skuOptionalstringThe SKU (stock keeping unit) of the product.
hsnMandatorystringThe HSN (Harmonized System of Nomenclature) code.
categoryMandatoryintegerThe category of the product.
required only if serviceName not present in request body
serviceNameOptionalStringif category is provided in request body than this field required
taxMandatoryintegerThe tax rate applicable to the product.
unitsMandatorystringThe units in which the product is measured.
currencyOptionalstringThe currency in which the amount is specified.
amountMandatoryintegerThe amount of the product.
saleMandatorybooleanIndicates if the product is available for sale.
buyMandatorybooleanIndicates if the product is available for purchase.
typeMandatorystringThe type of the product.
imageMandatorystringThe image URL of the product.

Response

  • success (boolean): Indicates whether the product addition was successful.

Headers

DICE-APP-IDstringOptional
Company Code of client
X-CLIENT-IDstringOptional
API Client ID
X-CLIENT-SECRETstringOptional
API Client Secret

Request

This endpoint expects an object.
idstringRequired
glstringRequired
titlestringRequired
desstringRequired
skustringRequired
hsnstringRequired
categoryintegerRequired
serviceNamestringRequired
taxintegerRequired
unitsstringRequired
currencystringRequired
amountintegerRequired
salebooleanRequired
buybooleanRequired
typestringRequired
imagestringRequired

Response

OK
successboolean