Skip to main content
ProductsVersion: v3

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.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:products.readonly
Auth methods:OAuthPrivate Integration
Token types:Sub-Account TokenAgency Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Path Parameters

productIdstringrequired

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

Example:6578278e879ad2646715ba9c

Query Parameters

locationIdstringrequired

location Id

Example:6578278e879ad2646715ba9c
sendWishlistStatusboolean

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

Example:true

Response

Successful response

_idstringrequired

The unique identifier for the product.

Example:655b33a82209e60b6adb87a5
descriptionstring

product description

Example:This is a really awesome product
variantsobject[]

An array of variants for the product.

locationIdstringrequired

The unique identifier for the location.

Example:3SwdhCsvxI8Au3KsPJt6
namestringrequired

The name of the product.

Example:Awesome Product
productTypestringrequired

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

Example:PHYSICAL
availableInStoreboolean

Indicates whether the product is available in-store.

Example:true
createdAtstring<date-time>required

The creation timestamp of the product.

Example:2023-11-20T10:23:36.515Z
updatedAtstring<date-time>required

The last update timestamp of the product.

Example:2024-01-23T09:57:04.846Z
statementDescriptorstring

The statement descriptor for the product.

Example:abcde
imagestring

The URL for the product image.

Example:https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/65af8d5df88bdb4b1022ee90.png
collectionIdsstring[]

An array of category Ids for the product

Example:["65d71377c326ea78e1c47df5","65d71377c326ea78e1c47d34"]
isTaxesEnabledboolean

The field indicates whether taxes are enabled for the product or not.

Default:false
Example:true
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.

Example:["654492a4e6bef380114de15a"]
automaticTaxCategoryIdstring

Tax category ID for Automatic taxes calculation.

Example:65d71377c326ea78e1c47df5
labelobject

The Product label details

slugstring

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

Example:washing-machine