# Export item families

> For the complete machine-readable documentation index, see [llms.txt](https://apidocs.chargebee.com/llms.txt).


[Idempotency Supported](/docs/api/idempotency)

[Eventually Consistent](/docs/api/read-consistency)

This API triggers export of item family data. The exported zip file contains CSV files with item family-related data.

## Sample Request

#### cURL

```bash
curl  https://{site}.chargebee.com/api/v2/exports/item_families \
     -u {site_api_key}:\
     -d "item_family[name][is]"="acme-INC"
```

#### .NET

```dotnet
using ChargeBee.Api;
using ChargeBee.Models;

ApiConfig.Configure("{site}","{site_api_key}");
EntityResult result = Export.ItemFamilies()
		.ItemFamilyName().Is("acme-INC")
		.Request();

Export export = result.Export;
```

#### Go

```go
package main
import (
    "fmt"
    "github.com/chargebee/chargebee-go/v3"
    "github.com/chargebee/chargebee-go/v3/filter"
    exportAction "github.com/chargebee/chargebee-go/v3/actions/export"
    "github.com/chargebee/chargebee-go/v3/models/export"
)
func main() {
    chargebee.Configure("{site_api_key}","{site}");
    res,err := exportAction.ItemFamilies(&export.ItemFamiliesRequestParams{
        ItemFamily : &export.ItemFamiliesItemFamilyParams{
            Name : &filter.StringFilter{
                Is : "acme-INC",
            },
        },
    }).Request()
    if err != nil {
        fmt.Println(err)
    } else {
        Export := res.Export
    }
}
```

#### Go

```go
package main

import (
  "fmt"
  "github.com/chargebee/chargebee-go/v4"
)

func main() {
  config := &chargebee.ClientConfig{
    SiteName: "{site}",
    ApiKey: "{site_api_key}",
  }    
  client := chargebee.NewClient(config)
  req := &chargebee.ExportItemFamiliesRequest{
    ItemFamily : &chargebee.ExportItemFamiliesItemFamily{
        Name : &chargebee.StringFilter{
            Is : "acme-INC",
        },
    },
}
  res, err := client.Export.ItemFamilies(req)
      if err != nil {
        fmt.Println(err)
    } else {
        Export := res.Export
    }
}
```

#### Java

```java
import com.chargebee.*;
import com.chargebee.ListResult;
import com.chargebee.models.*;
import com.chargebee.models.enums.*;
import java.io.IOException;

public class Sample {

    public static void main(String args[]) throws IOException, Exception {
        Environment.configure("{site}", "{site_api_key}");
        Result result = Export.itemFamilies().itemFamilyName().is("acme-INC").request();

        Export export = result.export();
    }
}
```

#### Java

```java
import com.chargebee.v4.client.ChargebeeClient;
import com.chargebee.v4.models.export.Export;
import com.chargebee.v4.models.export.params.ExportItemFamiliesParams;
import com.chargebee.v4.models.export.responses.ExportItemFamiliesResponse;

public class ExportItemFamilies {

    public static void main(String[] args) {
        ChargebeeClient client = ChargebeeClient.builder()
            .apiKey("{site_api_key}")
            .siteName("{site}")
            .build();

        ExportItemFamiliesParams.ItemFamilyParams itemFamily =
            ExportItemFamiliesParams.ItemFamilyParams.builder()
                .name()
                .is("acme-INC")
                .build();

        ExportItemFamiliesParams params = ExportItemFamiliesParams.builder()
            .itemFamily(itemFamily)
            .build();

        ExportItemFamiliesResponse response = client.exports().itemFamilies(params);

        Export export = response.getExport();
    }
}
```

#### Node.js

```node
import Chargebee from "chargebee";

const chargebee = new Chargebee({
    site: "{site}",
    apiKey: "{site_api_key}",
});

try {
    const result = await chargebee.export.itemFamilies({
        item_family: {
            name: {
                is: "acme-INC"
            }
        }
    });

    console.log(result);
    const export_response = result.export;
} catch (err) {
    console.log(err);
}
```

#### PHP

```php
<?php

require __DIR__ . '/vendor/autoload.php';

use Chargebee\ChargebeeClient;

$chargebee = new ChargebeeClient(options: [
    "site" => "{site}",
    "apiKey" => "{site_api_key}",
]);
$result = $chargebee->export()->itemFamilies([
    "item_family" => [
        "name" => [
            "is" => "acme-INC"
        ]
    ]
]);
$export = $result->export;
```

#### Python

```python
import chargebee
from chargebee import Chargebee, Filters

cb_client = Chargebee(api_key="{site_api_key}", site="{site}")
response = cb_client.Export.item_families(
    cb_client.Export.ItemFamiliesParams(
        item_family=cb_client.Export.ItemFamiliesItemFamilyParams(
            name=Filters.StringFilter(IS="acme-INC")
        )
    )
)
export = response.export
```

#### Ruby

```ruby
require 'chargebee'

ChargeBee.configure(:site => "{site}",
  :api_key => "{site_api_key}")

result = ChargeBee::Export.item_families({
  "item_family[name][is]" => "acme-INC"
})

export = result.export
```

## Sample Response

```json
{
  "export": {
    "created_at": 1527791400,
    "id": "__test__8at0kS38wNVKS",
    "mime_type": "zip",
    "object": "export",
    "operation_type": "Item Families",
    "status": "in_process"
  }
}
```

## URL Format

**POST** https://[site].chargebee.com/api/v2/exports/item_families

## Input Parameters

- `business_entity_id` (optional, string)
  optional, string filter
  
  The unique ID of the [business entity](/docs/api/business_entities) of this `item_family`. [Learn more](/docs/api/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"_

- `include_site_level_resources` (optional, enumerated string)
  optional, boolean filter
  
  Default value is `true` . To exclude site-level resources in [specific cases](/docs/api/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"_

- `item_family` (optional, string)
  Parameters for item\_family
  - `id` (optional, string)
    The identifier for the item family. It is unique and immutable.
  - `name` (optional, string)
    A unique display name for the item family. This is visible only in Chargebee and not to customers.
  - `updated_at` (optional, timestamp(UTC) in seconds)
    When the item family was last updated.
    - `after` (optional, timestamp(UTC) in seconds)
    - `before` (optional, timestamp(UTC) in seconds)
    - `on` (optional, timestamp(UTC) in seconds)

## Returns

- `export` (Export object)
  Resource object representing export