Skip to main content
ProductsVersion: v3

Update Product by ID

PUT/products/{productId}

The "Update Product by ID" API allows modifying information for a specific product using its unique identifier. Use this endpoint to update 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.write
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

Body

namestringrequired

The name of the product.

Example:Awesome Product
locationIdstringrequired

The unique identifier for the location.

Example:3SwdhCsvxI8Au3KsPJt6
descriptionstring

A brief description of the product.

Example:Product description goes here.
productTypestringrequired
Available optionsDIGITALPHYSICALSERVICEPHYSICAL/DIGITAL
imagestring

The URL for the product image.

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

The statement descriptor for the product.

Example:abcde
availableInStoreboolean

Indicates whether the product is available in-store.

Example:true
mediasobject[]

An array of medias for the product.

variantsobject[]

An array of variants for the product.

collectionIdsstring[]

An array of category Ids for the product

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

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

Default:false
Example:true
taxesstring[]

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

Example:["654492a4e6bef380114de15a"]
automaticTaxCategoryIdstring

Tax category ID for Automatic taxes calculation.

Example:65d71377c326ea78e1c47df5
isLabelEnabledboolean

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

Default:false
Example:true
labelobject

Details for Product Label

slugstring

The slug using which the product navigation will be handled

Example:awesome-product
seoobject

SEO data for the product that will be displayed in the preview

taxInclusiveboolean

Whether the taxes should be included in the purchase price

Default:false
Example:true
pricesstring[]

The prices of the product

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