Interface CommercetoolsApiConfig

Configuration for constructing the {@see CommercetoolsApi} class.

interface CommercetoolsApiConfig {
    clientId: string;
    clientScopes: string[];
    clientSecret: string;
    customerScopes?: string[];
    httpsAgent?: Agent;
    onAfterResponse?: ((response) => void);
    onBeforeRequest?: ((requestConfig) => CommercetoolsRequest | Promise<CommercetoolsRequest>);
    projectKey: string;
    refreshIfWithinSecs?: number;
    region: Region;
    retry?: Partial<CommercetoolsRetryConfig>;
    storeKey?: string;
    systemIdentifier?: string;
    timeoutMs?: number;
}

Hierarchy (view full)

Properties

clientId clientScopes clientSecret customerScopes? httpsAgent? onAfterResponse? onBeforeRequest? projectKey refreshIfWithinSecs? region retry? storeKey? systemIdentifier? timeoutMs?

Properties

clientId

clientId: string

clientScopes

clientScopes: string[]

clientSecret

clientSecret: string

Optional customerScopes

customerScopes?: string[]

Optional httpsAgent

httpsAgent?: Agent

Optional onAfterResponse

onAfterResponse?: ((response) => void)

If passed in, will be called once a request has been made and the response received (or error thrown).

Type declaration

Optional onBeforeRequest

onBeforeRequest?: ((requestConfig) => CommercetoolsRequest | Promise<CommercetoolsRequest>)

If passed in, will be called before sending a request to commercetools. The {@see requestConfig} parameter can be manipulated if you wish to modify/add headers or any other request data.

Type declaration

projectKey

projectKey: string

Optional refreshIfWithinSecs

refreshIfWithinSecs?: number

region

region: Region

Optional retry

retry?: Partial<CommercetoolsRetryConfig>

Optional storeKey

storeKey?: string

Optional systemIdentifier

systemIdentifier?: string

If provided, will be passed across to commercetools in the 'User-Agent' HTTP header, in order to help commercetools identify the source of incoming requests.

Optional timeoutMs

timeoutMs?: number

Settings

Member Visibility

Theme

On This Page

clientIdclientScopesclientSecretcustomerScopeshttpsAgentonAfterResponseonBeforeRequestprojectKeyrefreshIfWithinSecsregionretrystoreKeysystemIdentifiertimeoutMs