Function CatalogApiFactory

CatalogApi - factory interface

Export

  • CatalogApiFactory(
        configuration?: Configuration,
        basePath?: string,
        axios?: AxiosInstance,
    ): {
        getCatalogItem(
            requestParameters: CatalogApiGetCatalogItemRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<Item>;
        searchCatalogItems(
            requestParameters: CatalogApiSearchCatalogItemsRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<ItemSearchResults>;
    }

  • Parameters

    • Optionalconfiguration: Configuration
    • OptionalbasePath: string
    • Optionalaxios: AxiosInstance

    Returns {
        getCatalogItem(
            requestParameters: CatalogApiGetCatalogItemRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<Item>;
        searchCatalogItems(
            requestParameters: CatalogApiSearchCatalogItemsRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<ItemSearchResults>;
    }

    • getCatalogItem:function
      • getCatalogItem(
            requestParameters: CatalogApiGetCatalogItemRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<Item>

      • Retrieves details for an item in the Amazon catalog. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        Returns AxiosPromise<Item>

        Throws

    • searchCatalogItems:function
      • searchCatalogItems(
            requestParameters: CatalogApiSearchCatalogItemsRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<ItemSearchResults>

      • Search for and return a list of Amazon catalog items and associated information. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        Returns AxiosPromise<ItemSearchResults>

        Throws

Settings

Member Visibility