---
editLink: false
lastUpdated: false
---

[@salesforce/b2c-tooling-sdk](../../../modules.md) / [operations/cip](../index.md) / CipReportDefinition

# Interface: CipReportDefinition

Defined in: [packages/b2c-tooling-sdk/src/operations/cip/types.ts:45](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/operations/cip/types.ts#L45)

Curated CIP report definition.

## Properties

### buildSql()

> **buildSql**: (`params`) => `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/cip/types.ts:50](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/operations/cip/types.ts#L50)

#### Parameters

##### params

`Record`\<`string`, `string`\>

#### Returns

`string`

***

### category

> **category**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/cip/types.ts:48](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/operations/cip/types.ts#L48)

***

### description

> **description**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/cip/types.ts:47](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/operations/cip/types.ts#L47)

***

### name

> **name**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/cip/types.ts:46](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/operations/cip/types.ts#L46)

***

### parameters

> **parameters**: [`CipReportParamDefinition`](CipReportParamDefinition.md)[]

Defined in: [packages/b2c-tooling-sdk/src/operations/cip/types.ts:49](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/operations/cip/types.ts#L49)

***

### tablesUsed?

> `optional` **tablesUsed**: `string`[]

Defined in: [packages/b2c-tooling-sdk/src/operations/cip/types.ts:55](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/operations/cip/types.ts#L55)

Optional list of warehouse tables the report reads, for discoverability in
`--describe` output and the report listing command. Does not affect SQL.