Skip to main content
PUT
/
products
/
{productId}
Update Product by ID
curl --request PUT \
  --url https://services.leadconnectorhq.com/products/{productId} \
  --header 'Content-Type: application/json' \
  --header 'Version: <version>' \
  --data '
{
  "name": "Awesome Product",
  "locationId": "3SwdhCsvxI8Au3KsPJt6",
  "productType": "DIGITAL",
  "description": "Product description goes here.",
  "image": "https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/65af8d5df88bdb4b1022ee90.png",
  "statementDescriptor": "abcde",
  "availableInStore": true,
  "medias": [
    {
      "id": "fzrgusiuu0m",
      "url": "https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/sample.png",
      "type": "image",
      "title": "1dd7dcd0-e71d-4cf7-a06b-6d47723d6a29.png",
      "isFeatured": true,
      "priceIds": "6578278e879ad2646715ba9c"
    }
  ],
  "variants": [
    {
      "id": "38s63qmxfr4",
      "name": "Size",
      "options": [
        {
          "id": "h4z7u0im2q8",
          "name": "XL"
        }
      ]
    }
  ],
  "collectionIds": [
    "65d71377c326ea78e1c47df5",
    "65d71377c326ea78e1c47d34"
  ],
  "isTaxesEnabled": true,
  "taxes": [
    "654492a4e6bef380114de15a"
  ],
  "automaticTaxCategoryId": "65d71377c326ea78e1c47df5",
  "isLabelEnabled": true,
  "slug": "awesome-product",
  "seo": {
    "title": "Best Product - Buy Now",
    "description": "This is the best product you can buy online with amazing features and great value"
  },
  "taxInclusive": true,
  "prices": [
    "<string>"
  ]
}
'
{
  "_id": "655b33a82209e60b6adb87a5",
  "locationId": "3SwdhCsvxI8Au3KsPJt6",
  "name": "Awesome Product",
  "productType": "PHYSICAL",
  "createdAt": "2023-11-20T10:23:36.515Z",
  "updatedAt": "2024-01-23T09:57:04.846Z",
  "description": "This is a really awesome product",
  "variants": [
    {
      "id": "38s63qmxfr4",
      "name": "Size",
      "options": [
        {
          "id": "h4z7u0im2q8",
          "name": "XL"
        }
      ]
    }
  ],
  "availableInStore": true,
  "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"
}

Headers

​
Version
enum<string>
required

API Version

Available options:
2021-07-28

Path Parameters

​
productId
string
required

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

Example:

"6578278e879ad2646715ba9c"

Body

application/json
​
name
string
required

The name of the product.

Example:

"Awesome Product"

​
locationId
string
required

The unique identifier for the location.

Example:

"3SwdhCsvxI8Au3KsPJt6"

​
productType
enum<string>
required
Available options:
DIGITAL,
PHYSICAL,
SERVICE,
PHYSICAL/DIGITAL
​
description
string

A brief description of the product.

Example:

"Product description goes here."

​
image
string

The URL for the product image.

Example:

"https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/65af8d5df88bdb4b1022ee90.png"

​
statementDescriptor
string

The statement descriptor for the product.

Example:

"abcde"

​
availableInStore
boolean

Indicates whether the product is available in-store.

Example:

true

​
medias
object[]

An array of medias for the product.

​
variants
object[]

An array of variants for the product.

​
collectionIds
string[]

An array of category Ids for the product

Example:
[
  "65d71377c326ea78e1c47df5",
  "65d71377c326ea78e1c47d34"
]
​
isTaxesEnabled
boolean
default:false

Are there any taxes attached to the product. If this is true, taxes array cannot be empty.

Example:

true

​
taxes
string[]

List of ids of Taxes attached to the Product. If taxes are passed, isTaxesEnabled should be true.

Example:
["654492a4e6bef380114de15a"]
​
automaticTaxCategoryId
string

Tax category ID for Automatic taxes calculation.

Example:

"65d71377c326ea78e1c47df5"

​
isLabelEnabled
boolean
default:false

Is the product label enabled. If this is true, label object cannot be empty.

Example:

true

​
label
object
​
slug
string

The slug using which the product navigation will be handled

Example:

"awesome-product"

​
seo
object
​
taxInclusive
boolean
default:false

Whether the taxes should be included in the purchase price

Example:

true

​
prices
string[]

The prices of the product

Response

Successful response

​
_id
string
required

The unique identifier for the product.

Example:

"655b33a82209e60b6adb87a5"

​
locationId
string
required

The unique identifier for the location.

Example:

"3SwdhCsvxI8Au3KsPJt6"

​
name
string
required

The name of the product.

Example:

"Awesome Product"

​
productType
string
required

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

Example:

"PHYSICAL"

​
createdAt
string<date-time>
required

The creation timestamp of the product.

Example:

"2023-11-20T10:23:36.515Z"

​
updatedAt
string<date-time>
required

The last update timestamp of the product.

Example:

"2024-01-23T09:57:04.846Z"

​
description
string

product description

Example:

"This is a really awesome product"

​
variants
object[]

An array of variants for the product.

​
availableInStore
boolean

Indicates whether the product is available in-store.

Example:

true

​
statementDescriptor
string

The statement descriptor for the product.

Example:

"abcde"

​
image
string

The URL for the product image.

Example:

"https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/65af8d5df88bdb4b1022ee90.png"

​
collectionIds
string[]

An array of category Ids for the product

Example:
[
  "65d71377c326ea78e1c47df5",
  "65d71377c326ea78e1c47d34"
]
​
isTaxesEnabled
boolean
default:false

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

Example:

true

​
taxes
string[]

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"]
​
automaticTaxCategoryId
string

Tax category ID for Automatic taxes calculation.

Example:

"65d71377c326ea78e1c47df5"

​
label
object
​
slug
string

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

Example:

"washing-machine"

Last modified on March 8, 2026