POST /exports/item_families
This API triggers export of item family data. The exported zip file contains CSV files with item family-related data.
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 |
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:
|
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:
|
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-event-email |
String | No |
skip only emails Possible values:
|
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
business_entity_id |
Object | No |
optional, string filter The unique ID of the [business entity](/docs/api/business_entities) of this `item_family`. [Learn more](using_business_entity_filters_in_product_catalog_list_apis) about all the scenarios before using this filter. **Supported operators :** is, is_present **Example →** *business_entity_id\[is_present\] = "true"* |
business_entity_id.is |
String | No | |
business_entity_id.is_present |
String | No |
null Possible values:
|
item_family |
Object | No |
Parameters for item_family |
item_family.id |
Object | No |
The identifier for the item family. It is unique and immutable. |
item_family.id.not_in |
String | No | |
item_family.id.starts_with |
String | No | |
item_family.id.in |
String | No | |
item_family.id.is_not |
String | No | |
item_family.id.is |
String | No | |
item_family.name |
Object | No |
A unique display name for the item family. This is visible only in Chargebee and not to customers. |
item_family.name.starts_with |
String | No | |
item_family.name.is_not |
String | No | |
item_family.name.is |
String | No | |
item_family.updated_at |
Object | No |
When the item family was last updated. |
item_family.updated_at.on |
String | No | |
item_family.updated_at.after |
String | No | |
item_family.updated_at.between |
String | No | |
item_family.updated_at.before |
String | No | |
include_site_level_resources |
Object | No |
optional, boolean filter Default value is `true` . To exclude site-level resources in [specific cases](using_business_entity_filters_in_product_catalog_list_apis), set this parameter to `false`. Possible values are : *true, false* **Supported operators :** is **Example →** *include_site_level_resources\[is\] = "null"* |
include_site_level_resources.is |
String | No |
Possible values:
|
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.