Selling Partner API SDK for JavaScript
    Preparing search index...

    Interface ClientConfiguration

    Configuration options for creating a Selling Partner API Axios instance.

    interface ClientConfiguration {
        auth: SellingPartnerApiAuth;
        logging?: {
            error?: true | ErrorLogConfig;
            request?: true | RequestLogConfig;
            response?: true | ResponseLogConfig;
        };
        rateLimiting?: {
            onRetry?: (retryInfo: OnRetryParameters) => void;
            retry: boolean;
        };
        region: SellingPartnerRegion;
        restrictedDataToken?: string;
        sandbox?: boolean;
        userAgent?: string;
    }
    Index

    Properties

    auth logging? rateLimiting? region restrictedDataToken? sandbox? userAgent?

    Properties

    auth: SellingPartnerApiAuth

    Authentication handler that provides LWA access tokens.

    logging?: {
        error?: true | ErrorLogConfig;
        request?: true | RequestLogConfig;
        response?: true | ResponseLogConfig;
    }

    Axios request/response/error logging configuration. Pass true to use defaults.

    Type Declaration

    • Optionalerror?: true | ErrorLogConfig

      Log request errors.

    • Optionalrequest?: true | RequestLogConfig

      Log outgoing requests.

    • Optionalresponse?: true | ResponseLogConfig

      Log incoming responses.

    rateLimiting?: {
        onRetry?: (retryInfo: OnRetryParameters) => void;
        retry: boolean;
    }

    Rate-limiting and retry configuration for 429 responses.

    Type Declaration

    • OptionalonRetry?: (retryInfo: OnRetryParameters) => void

      Optional callback invoked before each retry attempt.

    • retry: boolean

      When true, automatically retries throttled (HTTP 429) requests.

    region: SellingPartnerRegion

    Selling Partner API region to send requests to.

    restrictedDataToken?: string

    Restricted Data Token to use instead of the standard access token.

    sandbox?: boolean

    When true, requests are sent to the sandbox endpoint. Defaults to false.

    userAgent?: string

    Custom User-Agent header value.

    Settings

    Member Visibility

    On This Page

    Properties