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

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

# Interface: CartridgeOrder

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

Where the index's cartridge order came from:

- `configured`: the `cartridgePath` option (`cartridges` in dw.json or `SFCC_CARTRIDGES`).
- `instance`: a site's cartridge path read from the instance (the caller passed it as `cartridgePath`).
- `provided`: the caller passed ordered cartridges (for example the VS Code Cartridges view order).
- `site-file`: a site's `<custom-cartridges>` in a site import file in the project
  (`sites/<id>/site.xml`, the latest by migration or import set timestamp).
- `discovery`: a guess: discovery order with known base cartridges last.

## Properties

### allCartridges?

> `optional` **allCartridges**: `boolean`

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

True when every project cartridge was indexed (`includeAllCartridges`), including those in `notOnPath`.

***

### file?

> `optional` **file**: `string`

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

For `site-file`: the file, relative to the project root.

***

### hostname?

> `optional` **hostname**: `string`

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

For `instance`: the instance the path was read from.

***

### notOnPath?

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

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

Cartridges in the project that the cartridge path doesn't name. The site doesn't run their code, so they
are left out of the index (see [ProjectIndex.otherCartridges](ProjectIndex.md#othercartridges)) unless `includeAllCartridges` is set.

***

### otherSites?

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

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

For `instance` and `site-file`: other sites (on the instance, or in the project) with a different cartridge path.

***

### siteId?

> `optional` **siteId**: `string`

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

For `instance` and `site-file`: the site whose path was used.

***

### source

> **source**: `"instance"` \| `"discovery"` \| `"configured"` \| `"provided"` \| `"site-file"`

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