Skip to navigation

Fetch Product By Id

View as Markdown

Get Product Details

This endpoint retrieves detailed information about a specific product identified by its unique product code. The product code is passed as a part of the URL.

Request

  • Method: GET

  • Endpoint: {{host}}apis/external/product/getProduct/{productCode}

  • Path Parameter:

    • productCode: The unique identifier for the product (e.g., PRODUCT-INDIAN-0000013).

Response

On a successful request, the response will include a JSON object containing the product details. The structure of the response is as follows:

{
"product": {
"active": true,
"id": 43989,
"unit": "Nos",
"amount": 22.0,
"service": "Admin",
"categoryId": 19,
"productId": "PRODUCT-INDIAN-0000013",
"currency": "INR",
"title": "test product",
"image": "",
"hsn": "98765",
"sku": "11111",
"glcode": "",
"type": "product",
"description": "test product",
"tax": "18.0",
"orders": 0,
"orderAt": 0,
"sale": true,
"purchase": true
}
}

Example Response

{
"product": {
"active": true,
"id": 43989,
"unit": "Nos",
"amount": 22.0,
"service": "Admin",
"categoryId": 19,
"productId": "PRODUCT-INDIAN-0000013",
"currency": "INR",
"title": "test product",
"image": "",
"hsn": "98765",
"sku": "11111",
"glcode": "",
"type": "product",
"description": "test product",
"tax": "18.0",
"orders": 0,
"orderAt": 0,
"sale": true,
"purchase": true
}
}

Headers

DICE-APP-IDstringOptional
X-CLIENT-IDstringOptional
X-CLIENT-SECRETstringOptional

Response headers

request-idstringOptional

Response

OK
productobject