Function CatalogApiFp

CatalogApi - functional programming interface

Export

  • CatalogApiFp(
        configuration?: Configuration,
    ): {
        getCatalogItem(
            marketplaceId: string,
            asin: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetCatalogItemResponse>,
        >;
        listCatalogCategories(
            marketplaceId: string,
            aSIN?: string,
            sellerSKU?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ListCatalogCategoriesResponse>,
        >;
        listCatalogItems(
            marketplaceId: string,
            query?: string,
            queryContextId?: string,
            sellerSKU?: string,
            uPC?: string,
            eAN?: string,
            iSBN?: string,
            jAN?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ListCatalogItemsResponse>,
        >;
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        getCatalogItem(
            marketplaceId: string,
            asin: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetCatalogItemResponse>,
        >;
        listCatalogCategories(
            marketplaceId: string,
            aSIN?: string,
            sellerSKU?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ListCatalogCategoriesResponse>,
        >;
        listCatalogItems(
            marketplaceId: string,
            query?: string,
            queryContextId?: string,
            sellerSKU?: string,
            uPC?: string,
            eAN?: string,
            iSBN?: string,
            jAN?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ListCatalogItemsResponse>,
        >;
    }

    • getCatalogItem:function
      • getCatalogItem(
            marketplaceId: string,
            asin: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetCatalogItemResponse>,
        >

      • Effective September 30, 2022, the getCatalogItem operation will no longer be available in the Selling Partner API for Catalog Items v0. This operation is available in the latest version of the Selling Partner API for Catalog Items v2022-04-01. Integrations that rely on this operation should migrate to the latest version to avoid service disruption. Note: The listCatalogCategories operation is not being deprecated and you can continue to make calls to it.

        Parameters

        • marketplaceId: string

          A marketplace identifier. Specifies the marketplace for the item.

        • asin: string

          The Amazon Standard Identification Number (ASIN) of the item.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetCatalogItemResponse>,
        >

        Throws

    • listCatalogCategories:function
      • listCatalogCategories(
            marketplaceId: string,
            aSIN?: string,
            sellerSKU?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ListCatalogCategoriesResponse>,
        >

      • Returns the parent categories to which an item belongs, based on the specified ASIN or SellerSKU. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 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

        • marketplaceId: string

          A marketplace identifier. Specifies the marketplace for the item.

        • OptionalaSIN: string

          The Amazon Standard Identification Number (ASIN) of the item.

        • OptionalsellerSKU: string

          Used to identify items in the given marketplace. SellerSKU is qualified by the seller&#39;s SellerId, which is included with every operation that you submit.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ListCatalogCategoriesResponse>,
        >

        Throws

    • listCatalogItems:function
      • listCatalogItems(
            marketplaceId: string,
            query?: string,
            queryContextId?: string,
            sellerSKU?: string,
            uPC?: string,
            eAN?: string,
            iSBN?: string,
            jAN?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ListCatalogItemsResponse>,
        >

      • Effective September 30, 2022, the listCatalogItems operation will no longer be available in the Selling Partner API for Catalog Items v0. As an alternative, searchCatalogItems is available in the latest version of the Selling Partner API for Catalog Items v2022-04-01. Integrations that rely on the listCatalogItems operation should migrate to the searchCatalogItemsoperation to avoid service disruption. Note: The listCatalogCategories operation is not being deprecated and you can continue to make calls to it.

        Parameters

        • marketplaceId: string

          A marketplace identifier. Specifies the marketplace for which items are returned.

        • Optionalquery: string

          Keyword(s) to use to search for items in the catalog. Example: &#39;harry potter books&#39;.

        • OptionalqueryContextId: string

          An identifier for the context within which the given search will be performed. A marketplace might provide mechanisms for constraining a search to a subset of potential items. For example, the retail marketplace allows queries to be constrained to a specific category. The QueryContextId parameter specifies such a subset. If it is omitted, the search will be performed using the default context for the marketplace, which will typically contain the largest set of items.

        • OptionalsellerSKU: string

          Used to identify an item in the given marketplace. SellerSKU is qualified by the seller&#39;s SellerId, which is included with every operation that you submit.

        • OptionaluPC: string

          A 12-digit bar code used for retail packaging.

        • OptionaleAN: string

          A European article number that uniquely identifies the catalog item, manufacturer, and its attributes.

        • OptionaliSBN: string

          The unique commercial book identifier used to identify books internationally.

        • OptionaljAN: string

          A Japanese article number that uniquely identifies the product, manufacturer, and its attributes.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ListCatalogItemsResponse>,
        >

        Throws

Settings

Member Visibility