Function ListingsItemsApiFp

ListingsItemsApi - functional programming interface

Export

  • ListingsItemsApiFp(
        configuration?: Configuration,
    ): {
        deleteListingsItem(
            sellerId: string,
            sku: string,
            marketplaceIds: string[],
            issueLocale?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ListingsItemSubmissionResponse>,
        >;
        getListingsItem(
            sellerId: string,
            sku: string,
            marketplaceIds: string[],
            issueLocale?: string,
            includedData?: GetListingsItemIncludedDataEnum[],
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<Item>,
        >;
        patchListingsItem(
            sellerId: string,
            sku: string,
            marketplaceIds: string[],
            body: ListingsItemPatchRequest,
            includedData?: PatchListingsItemIncludedDataEnum[],
            mode?: "VALIDATION_PREVIEW",
            issueLocale?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ListingsItemSubmissionResponse>,
        >;
        putListingsItem(
            sellerId: string,
            sku: string,
            marketplaceIds: string[],
            body: ListingsItemPutRequest,
            includedData?: PutListingsItemIncludedDataEnum[],
            mode?: "VALIDATION_PREVIEW",
            issueLocale?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ListingsItemSubmissionResponse>,
        >;
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        deleteListingsItem(
            sellerId: string,
            sku: string,
            marketplaceIds: string[],
            issueLocale?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ListingsItemSubmissionResponse>,
        >;
        getListingsItem(
            sellerId: string,
            sku: string,
            marketplaceIds: string[],
            issueLocale?: string,
            includedData?: GetListingsItemIncludedDataEnum[],
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<Item>,
        >;
        patchListingsItem(
            sellerId: string,
            sku: string,
            marketplaceIds: string[],
            body: ListingsItemPatchRequest,
            includedData?: PatchListingsItemIncludedDataEnum[],
            mode?: "VALIDATION_PREVIEW",
            issueLocale?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ListingsItemSubmissionResponse>,
        >;
        putListingsItem(
            sellerId: string,
            sku: string,
            marketplaceIds: string[],
            body: ListingsItemPutRequest,
            includedData?: PutListingsItemIncludedDataEnum[],
            mode?: "VALIDATION_PREVIEW",
            issueLocale?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ListingsItemSubmissionResponse>,
        >;
    }

    • deleteListingsItem:function
      • deleteListingsItem(
            sellerId: string,
            sku: string,
            marketplaceIds: string[],
            issueLocale?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ListingsItemSubmissionResponse>,
        >

      • Delete a listings item for a selling partner. Note: The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to URL Encoding. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 10 | 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

        • sellerId: string

          A selling partner identifier, such as a merchant account or vendor code.

        • sku: string

          A selling partner provided identifier for an Amazon listing.

        • marketplaceIds: string[]

          A comma-delimited list of Amazon marketplace identifiers for the request.

        • OptionalissueLocale: string

          A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US` when a localization is not available in the specified locale.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • getListingsItem:function
      • getListingsItem(
            sellerId: string,
            sku: string,
            marketplaceIds: string[],
            issueLocale?: string,
            includedData?: GetListingsItemIncludedDataEnum[],
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Item>>

      • Returns details about a listings item for a selling partner. Note: The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to URL Encoding. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 10 | 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

        • sellerId: string

          A selling partner identifier, such as a merchant account or vendor code.

        • sku: string

          A selling partner provided identifier for an Amazon listing.

        • marketplaceIds: string[]

          A comma-delimited list of Amazon marketplace identifiers for the request.

        • OptionalissueLocale: string

          A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US` when a localization is not available in the specified locale.

        • OptionalincludedData: GetListingsItemIncludedDataEnum[]

          A comma-delimited list of data sets to include in the response. Default: `summaries`.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • patchListingsItem:function
      • patchListingsItem(
            sellerId: string,
            sku: string,
            marketplaceIds: string[],
            body: ListingsItemPatchRequest,
            includedData?: PatchListingsItemIncludedDataEnum[],
            mode?: "VALIDATION_PREVIEW",
            issueLocale?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ListingsItemSubmissionResponse>,
        >

      • Partially update (patch) a listings item for a selling partner. Only top-level listings item attributes can be patched. Patching nested attributes is not supported. Note: This operation has a throttling rate of one request per second when mode is VALIDATION_PREVIEW. Note: The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to URL Encoding. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 10 | 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

        • sellerId: string

          A selling partner identifier, such as a merchant account or vendor code.

        • sku: string

          A selling partner provided identifier for an Amazon listing.

        • marketplaceIds: string[]

          A comma-delimited list of Amazon marketplace identifiers for the request.

        • body: ListingsItemPatchRequest

          The request body schema for the `patchListingsItem` operation.

        • OptionalincludedData: PatchListingsItemIncludedDataEnum[]

          A comma-delimited list of data sets to include in the response. Default: `issues`.

        • Optionalmode: "VALIDATION_PREVIEW"

          The mode of operation for the request.

        • OptionalissueLocale: string

          A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US` when a localization is not available in the specified locale.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • putListingsItem:function
      • putListingsItem(
            sellerId: string,
            sku: string,
            marketplaceIds: string[],
            body: ListingsItemPutRequest,
            includedData?: PutListingsItemIncludedDataEnum[],
            mode?: "VALIDATION_PREVIEW",
            issueLocale?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ListingsItemSubmissionResponse>,
        >

      • Creates or fully updates an existing listings item for a selling partner. Note: This operation has a throttling rate of one request per second when mode is VALIDATION_PREVIEW. Note: The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to URL Encoding. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 10 | 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

        • sellerId: string

          A selling partner identifier, such as a merchant account or vendor code.

        • sku: string

          A selling partner provided identifier for an Amazon listing.

        • marketplaceIds: string[]

          A comma-delimited list of Amazon marketplace identifiers for the request.

        • body: ListingsItemPutRequest

          The request body schema for the `putListingsItem` operation.

        • OptionalincludedData: PutListingsItemIncludedDataEnum[]

          A comma-delimited list of data sets to include in the response. Default: `issues`.

        • Optionalmode: "VALIDATION_PREVIEW"

          The mode of operation for the request.

        • OptionalissueLocale: string

          A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US` when a localization is not available in the specified locale.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

Settings

Member Visibility