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

[@salesforce/b2c-tooling-sdk](../../modules.md) / [project-index](../index.md) / ProjectIndex

# Interface: ProjectIndex

Defined in: [packages/b2c-tooling-sdk/src/project-index/types.ts:246](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/project-index/types.ts#L246)

A JSON-serializable model of a B2C Commerce project's server-side entry points.

## Properties

### cartridgeOrder?

> `optional` **cartridgeOrder**: [`CartridgeOrder`](CartridgeOrder.md)

Defined in: [packages/b2c-tooling-sdk/src/project-index/types.ts:250](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/project-index/types.ts#L250)

Where the cartridge order came from.

***

### cartridges

> **cartridges**: [`IndexedCartridge`](IndexedCartridge.md)[]

Defined in: [packages/b2c-tooling-sdk/src/project-index/types.ts:248](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/project-index/types.ts#L248)

***

### customApis

> **customApis**: [`IndexedCustomApiEndpoint`](IndexedCustomApiEndpoint.md)[]

Defined in: [packages/b2c-tooling-sdk/src/project-index/types.ts:259](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/project-index/types.ts#L259)

***

### endpoints

> **endpoints**: [`IndexedEndpoint`](IndexedEndpoint.md)[]

Defined in: [packages/b2c-tooling-sdk/src/project-index/types.ts:257](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/project-index/types.ts#L257)

***

### errors

> **errors**: `object`[]

Defined in: [packages/b2c-tooling-sdk/src/project-index/types.ts:262](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/project-index/types.ts#L262)

Files that could not be parsed while indexing.

#### cartridge

> **cartridge**: `string`

#### message

> **message**: `string`

#### relPath

> **relPath**: `string`

***

### hooks

> **hooks**: [`IndexedHook`](IndexedHook.md)[]

Defined in: [packages/b2c-tooling-sdk/src/project-index/types.ts:258](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/project-index/types.ts#L258)

***

### jobSteps

> **jobSteps**: [`IndexedJobStep`](IndexedJobStep.md)[]

Defined in: [packages/b2c-tooling-sdk/src/project-index/types.ts:260](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/project-index/types.ts#L260)

***

### otherCartridges?

> `optional` **otherCartridges**: [`IndexedCartridge`](IndexedCartridge.md)[]

Defined in: [packages/b2c-tooling-sdk/src/project-index/types.ts:256](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/project-index/types.ts#L256)

Cartridges found in the project but not on the cartridge path. They are not indexed: no endpoints, route
steps, hooks, Custom APIs, or job steps come from them. Absent when the order is a guess or
`includeAllCartridges` is set (all cartridges are used).

***

### version

> **version**: `1`

Defined in: [packages/b2c-tooling-sdk/src/project-index/types.ts:247](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/project-index/types.ts#L247)
