POST /products/{product-id}

This API allows you to update specific product details.

The following table will help you to understand the status of the mapped item and item_price after passing product status value during product updation.

Product Status(Input parameter)	Item and Item Price Status
active	active
inactive	archived

Servers

{protocol}://{site}.{environment}:{port}/api/v2
{protocol}://{site}-test.{environment}:{port}/api/v2

Path parameters

Name	Type	Required	Description
`product-id`	String	Yes

Request headers

Name	Type	Required	Description
`chargebee-request-origin-device`	String	No	The device from which the customer has made the request
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/x-www-form-urlencoded"
`chargebee-event-webhook`	String	No	skip only webhooks Possible values: `"all-disabled"`
`chargebee-business-entity-id`	String	No	If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.
`chargebee-event-actions`	String	No	skip all actions to be done on the events Possible values: `"all-disabled"`
`chargebee-request-origin-user`	String	No	The email address of your customer/user. Use this when the email address has only ASCII characters.
`chargebee-request-origin-ip`	String	No	The IP address of the customer where the request originated
`chargebee-request-origin-user-encoded`	String	No	The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header `chargebee-request-origin-user` is ignored.
`chargebee-event-email`	String	No	skip only emails Possible values: `"all-disabled"`

Request body fields

Name	Type	Required	Description
`name`	String	No	A unique internal name for the product. This is only visible in Chargebee.
`sku`	String	No	A unique identifier code a seller assigns to each product or item. Retailers and merchants use SKUs to keep track of inventory and sales data and help organize products within a store or warehouse. SKUs can include a combination of letters, numbers, and symbols and can vary in length depending on the seller's needs.
`description`	String	No	Description of the product.
`external_name`	String	No	The unique name that appears for each product to the end user.
`metadata`	Object	No	A collection of key-value pairs that provides extra information about the product. Note: There's a character limit of 65,535. [Learn more](advanced-features#metadata).
`status`	String	No	Status of the product. Refer to the table for more information. * active - The active products are visible on the storefront, subscription, or checkout. * inactive - The inactive products are not visible on the storefront, subscription, or checkout. Possible values: `"inactive"` `"active"` Default value: "active"
`shippable`	Boolean	No	Whether a product is shippable or not. Pass the value as `true` if it is a shippable physical product, else pass the value as `false`. Default value: true

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.