Skip to navigation
Dice Standardized APIs V2 CopyProduct

Fetch Products API

View as Markdown

Fetch GRNs API

This API is to get all Product existing in Dice.

ParamsRequiredDescription
start_dateMandatoryDate filter, from which date the Products needs to be fetched.

Format - dd-MM-yyyy
end_dateMandatoryDate filter, till which date the Products need to be fetched.

Format - dd-MM-yyyy
offsetMandatoryPage Number
pageSizeOptionalNumber of Products to be fetched in a single page. Value cannot be greater than 5000.

If not provided along with the request then default value will be 1000 considered.

Response Body

ParamsTypeDescription
productsArrayAn array containing details of various products.
activeBooleanIndicates whether the product is active.
idIntegerThe unique ID of the product.
unitStringThe unit of measurement for the product.
amountIntegerThe amount associated with the product.
serviceStringThe service description of the product.
productIdStringThe unique ID of the product.
currencyStringThe currency code for the product.
titleStringThe title or name of the product.
imageStringThe URL or base64-encoded representation of the product’s image.
hsnStringThe Harmonized System Nomenclature (HSN) code for the product.
skuStringThe Stock Keeping Unit (SKU) for the product.
glcodeStringThe General Ledger (GL) code associated with the product.
typeStringThe type of the product.
descriptionStringThe description or details of the product.
taxStringThe tax rate associated with the product.
ordersIntegerThe number of orders for the product.
orderAtIntegerTimestamp indicating when the product was ordered.
saleBooleanIndicates whether the product is available for sale.
purchaseBooleanIndicates whether the product is available for purchase.
totalIntegerThe total number of products.
currentPageIntegerThe current page number.
totalPagesIntegerThe total number of pages based on the page size.

Response

{
  "products": [
    {
      "active": true,
      "id": 29286,
      "unit": "kg",
      "amount": 10,
      "service": "abc",
      "productId": "test",
      "currency": "AED",
      "title": "testt",
      "image": "https://example.com/image1",
      "hsn": "test",
      "sku": "test",
      "glcode": "test",
      "type": "product",
      "description": "est",
      "tax": "0.0",
      "orders": 0,
      "orderAt": 0,
      "sale": true,
      "purchase": true
    },
    {
      "active": false,
      "id": 33060,
      "unit": "ton",
      "amount": 1111,
      "service": "Budget Test Service 1",
      "productId": "PRODUCT-INDIAN-0000003",
      "currency": "INR",
      "title": "title1",
      "image": "https://example.com/image2",
      "hsn": "2312",
      "sku": "sku1",
      "glcode": "123123",
      "type": "product",
      "description": "desc1",
      "tax": "0.0",
      "orders": 0,
      "orderAt": 0,
      "sale": false,
      "purchase": true
    },
    // ... (additional product entries)
  ],
  "total": 16,
  "currentPage": 1,
  "totalPages": 1
}

Headers

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

Query parameters

offsetintegerOptional

Offset starts from 0 (Page Number), values can be 0, 1, 2

pageSizeintegerOptional
optinal parameter, default is 1000
start_datestringOptional

Date should be in dd-MM-yyyy format and it runs on CreatedAt

end_datestringOptional

Date should be in dd-MM-yyyy format and it runs on CreatedAt

Response

OK
productslist of objects
totalinteger
currentPageinteger
totalPagesinteger