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

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

# Interface: CipReportParamDefinition

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

Parameter contract for a curated CIP report.

## Properties

### default?

> `optional` **default**: `string`

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

Default value applied when the parameter is omitted. For `multiple`
parameters this may be a comma-separated string. Defaults are injected
before validation so a report can rely on the value being present.

***

### description

> **description**: `string`

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

***

### max?

> `optional` **max**: `number`

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

***

### min?

> `optional` **min**: `number`

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

***

### multiple?

> `optional` **multiple**: `boolean`

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

When true, the parameter accepts multiple comma-separated values, suitable
for a SQL `IN (...)` clause. Each value is validated against `options` when
both are set.

***

### name

> **name**: `string`

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

***

### options?

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

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

Allowed values for an enum-style parameter (for example `['4xx', '5xx']`).
When set, [CipReportParamType](../type-aliases/CipReportParamType.md) should be `string` and the value is
validated against this set before the report's SQL builder runs.

***

### required?

> `optional` **required**: `boolean`

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

***

### type

> **type**: [`CipReportParamType`](../type-aliases/CipReportParamType.md)

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