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

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

# Interface: IndexedCustomApiEndpoint

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

A Custom API endpoint from `rest-apis/<api>/api.json`, joined with its schema.yaml operation.

## Properties

### api

> **api**: `string`

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

***

### apiType

> **apiType**: `"unknown"` \| `"admin"` \| `"shopper"`

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

`shopper` (ShopperToken), `admin` (AmOAuth2), or `unknown`.

***

### cartridge

> **cartridge**: `string`

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

***

### endpoint

> **endpoint**: `string`

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

Endpoint name in api.json; matches the schema's operationId and the exported function.

***

### implementation?

> `optional` **implementation**: `string`

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

***

### implementationFile?

> `optional` **implementationFile**: `object`

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

Implementation script relative to the cartridge, and the exported function's line.

#### line?

> `optional` **line**: `number`

#### relPath

> **relPath**: `string`

***

### method?

> `optional` **method**: `string`

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

HTTP method from schema.yaml (`GET`).

***

### path?

> `optional` **path**: `string`

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

Path from schema.yaml (`/loyalty-info`).

***

### problems

> **problems**: `string`[]

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

Problems found while joining api.json, schema.yaml, and the script.

***

### public?

> `optional` **public**: `boolean`

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

Whether the exported function is marked `.public = true` (required).

***

### schema?

> `optional` **schema**: `string`

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

***

### scopes?

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

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

Scopes required by the security requirement (`c_loyalty`).

***

### security?

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

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

Security schemes that apply (`ShopperToken`, `AmOAuth2`).
