Interface CommonRequestOptions

Options that are available to all requests.

interface CommonRequestOptions {
    correlationId?: string;
    params?: Record<string, undefined | string | number | boolean | (string | number | boolean)[]>;
    retry?: CommercetoolsRetryConfig;
}

Hierarchy (view full)

Properties

correlationId? params? retry?

Properties

Optional correlationId

correlationId?: string

A unique id used to track the source of a request.

Optional params

params?: Record<string, undefined | string | number | boolean | (string | number | boolean)[]>

Query string parameters. For repeated param=value in the query string, define an array with values

Optional retry

retry?: CommercetoolsRetryConfig

Retry configuration

Settings

Member Visibility

Theme

On This Page

correlationIdparamsretry