Get Product by ID

GET 
/products/:productId

The "Get Product by ID" API allows to retrieve information for a specific product using its unique identifier. Use this endpoint to fetch details for a single product based on the provided product ID.

Request

Version stringrequired

API Version

Available optionsv3

productId stringrequired

ID or the slug of the product that needs to be returned

locationId stringrequired

location Id

sendWishlistStatus boolean

Parameter which will decide whether to show the wishlisting status of products

application/json

Successful response

application/json

Schema

Schema

_idstringrequired

The unique identifier for the product.

descriptionstring

product description

variantsobject[]

An array of variants for the product.

locationIdstringrequired

The unique identifier for the location.

namestringrequired

The name of the product.

productTypestringrequired

The type of the product (e.g., PHYSICAL).

availableInStoreboolean

Indicates whether the product is available in-store.

createdAtstring<date-time>required

The creation timestamp of the product.

updatedAtstring<date-time>required

The last update timestamp of the product.

statementDescriptorstring

The statement descriptor for the product.

imagestring

The URL for the product image.

collectionIdsstring[]

An array of category Ids for the product

isTaxesEnabledboolean
The field indicates whether taxes are enabled for the product or not.
Default value: false
taxesstring[]

An array of ids of Taxes attached to the Product. If the expand query includes tax, the taxes will be of type ProductTaxDto. Please refer to the ProductTaxDto for additional details.

automaticTaxCategoryIdstring

Tax category ID for Automatic taxes calculation.

labelobject

The Product label details

slugstring

The slug of the product by which the product will be navigated

Example (auto)

{
  "_id": "655b33a82209e60b6adb87a5",
  "description": "This is a really awesome product",
  "variants": [
    {
      "id": "38s63qmxfr4",
      "name": "Size",
      "options": [
        {
          "id": "h4z7u0im2q8",
          "name": "XL"
        }
      ]
    }
  ],
  "locationId": "3SwdhCsvxI8Au3KsPJt6",
  "name": "Awesome Product",
  "productType": "PHYSICAL",
  "availableInStore": true,
  "createdAt": "2023-11-20T10:23:36.515Z",
  "updatedAt": "2024-01-23T09:57:04.846Z",
  "statementDescriptor": "abcde",
  "image": "https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/65af8d5df88bdb4b1022ee90.png",
  "collectionIds": [
    "65d71377c326ea78e1c47df5",
    "65d71377c326ea78e1c47d34"
  ],
  "isTaxesEnabled": true,
  "taxes": [
    "654492a4e6bef380114de15a"
  ],
  "automaticTaxCategoryId": "65d71377c326ea78e1c47df5",
  "label": {
    "title": "Featured",
    "startDate": "2024-06-26T05:43:35.000Z",
    "endDate": "2024-06-30T05:43:39.000Z"
  },
  "slug": "washing-machine"
}