GET /products

This API retrieves the list of products that are active or inactive. Use include_deleted parameter to include deleted products with active and inactive products.

Servers

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

Request headers

Name	Type	Required	Description
`chargebee-request-origin-device`	String	No	The device from which the customer has made the request
`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-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.

Query parameters

Name	Type	Required	Description
`id`	Object	No	optional, string filterFilter product based on their id.Supported operators : is, is_not, starts_with, in, not_inExample → id[is] = "basic"
`has_variant`	Object	No	optional, boolean filterFilter product based on whether it has variants or not. Possible values are : true, false Supported operators : isExample → has_variant[is] = "true"
`limit`	Integer	No	The number of resources to be returned. Default value: 10
`name`	Object	No	optional, string filterFilter product based on their `name`s.Supported operators : is, is_not, starts_with, in, not_inExample → name[is] = "basic"
`status`	Object	No	optional, enumerated string filterFilter product based on their `status`. Possible values are : active, inactive.Supported operators : is, is_not, in, not_inExample → status[is] = "basic"
`created_at`	Object	No	optional, timestamp(UTC) in seconds filterFilter product based on their `created time`.Supported operators : after, before, on, betweenExample → created_at[after] = "1243545465"
`shippable`	Object	No	optional, boolean filterFilter product based on whether it is shippable or not. Possible values are : true, false Supported operators : isExample → shippable[is] = "true"
`sort_by`	Object	No	optional, string filterSorts based on the specified attribute. Supported attributes : name, id, created_at, updated_atSupported sort-orders : asc, descExample → sort_by[asc] = "name"This will sort the result based on the 'name' attribute in ascending(earliest first) order.
`offset`	String	No	Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set `offset` to the value of `next_offset` obtained in the previous iteration of the API call.
`include_deleted`	Boolean	No	If set to true, includes the deleted resources in the response. For the deleted resources in the response, the '\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\deleted\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\ ' attribute will be '\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\true\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\'. Default value: false
`updated_at`	Object	No	optional, timestamp(UTC) in seconds filterFilter product based on their `updated time`.Supported operators : after, before, on, betweenExample → updated_at[after] = "1243545465"

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.