Function ListingsApiFp

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>,
    >;
    searchListingsItems(
        sellerId: string,
        marketplaceIds: string[],
        issueLocale?: string,
        includedData?: SearchListingsItemsIncludedDataEnum[],
        identifiers?: string[],
        identifiersType?: SearchListingsItemsIdentifiersTypeEnum,
        variationParentSku?: string,
        packageHierarchySku?: string,
        createdAfter?: string,
        createdBefore?: string,
        lastUpdatedAfter?: string,
        lastUpdatedBefore?: string,
        withIssueSeverity?: SearchListingsItemsWithIssueSeverityEnum[],
        withStatus?: SearchListingsItemsWithStatusEnum[],
        withoutStatus?: SearchListingsItemsWithoutStatusEnum[],
        sortBy?: SearchListingsItemsSortByEnum,
        sortOrder?: SearchListingsItemsSortOrderEnum,
        pageSize?: number,
        pageToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ItemSearchResults>,
    >;
}

• 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. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can receive higher rate and burst values then those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API documentation.

    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

• searchListingsItems:function

  • searchListingsItems(
        sellerId: string,
        marketplaceIds: string[],
        issueLocale?: string,
        includedData?: SearchListingsItemsIncludedDataEnum[],
        identifiers?: string[],
        identifiersType?: SearchListingsItemsIdentifiersTypeEnum,
        variationParentSku?: string,
        packageHierarchySku?: string,
        createdAfter?: string,
        createdBefore?: string,
        lastUpdatedAfter?: string,
        lastUpdatedBefore?: string,
        withIssueSeverity?: SearchListingsItemsWithIssueSeverityEnum[],
        withStatus?: SearchListingsItemsWithStatusEnum[],
        withoutStatus?: SearchListingsItemsWithoutStatusEnum[],
        sortBy?: SearchListingsItemsSortByEnum,
        sortOrder?: SearchListingsItemsSortOrderEnum,
        pageSize?: number,
        pageToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ItemSearchResults>,
    >

  • Search for and return a list of selling partner listings items and their respective details. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

    Parameters

    • sellerId: string

      A selling partner identifier, such as a merchant account or vendor code.
    • marketplaceIds: string[]

      A comma-delimited list of Amazon marketplace identifiers for the request.
    • OptionalissueLocale: string

      A locale that is used to localize issues. When not provided, the default language code of the first marketplace is used. Examples: &quot;en_US&quot;, &quot;fr_CA&quot;, &quot;fr_FR&quot;. When a localization is not available in the specified locale, localized messages default to &quot;en_US&quot;.
    • OptionalincludedData: SearchListingsItemsIncludedDataEnum[]

      A comma-delimited list of datasets that you want to include in the response. Default: `summaries`.
    • Optionalidentifiers: string[]

      A comma-delimited list of product identifiers that you can use to search for listings items. Note: 1. This is required when you specify `identifiersType`. 2. You cannot use &#39;identifiers&#39; if you specify `variationParentSku` or `packageHierarchySku`.
    • OptionalidentifiersType: SearchListingsItemsIdentifiersTypeEnum

      A type of product identifiers that you can use to search for listings items. Note: This is required when `identifiers` is provided.
    • OptionalvariationParentSku: string

      Filters results to include listing items that are variation children of the specified SKU. Note: You cannot use `variationParentSku` if you include `identifiers` or `packageHierarchySku` in your request.
    • OptionalpackageHierarchySku: string

      Filter results to include listing items that contain or are contained by the specified SKU. Note: You cannot use `packageHierarchySku` if you include `identifiers` or `variationParentSku` in your request.
    • OptionalcreatedAfter: string

      A date-time that is used to filter listing items. The response includes listings items that were created at or after this time. Values are in ISO 8601 date-time format.
    • OptionalcreatedBefore: string

      A date-time that is used to filter listing items. The response includes listings items that were created at or before this time. Values are in ISO 8601 date-time format.
    • OptionallastUpdatedAfter: string

      A date-time that is used to filter listing items. The response includes listings items that were last updated at or after this time. Values are in ISO 8601 date-time format.
    • OptionallastUpdatedBefore: string

      A date-time that is used to filter listing items. The response includes listings items that were last updated at or before this time. Values are in ISO 8601 date-time format.
    • OptionalwithIssueSeverity: SearchListingsItemsWithIssueSeverityEnum[]

      Filter results to include only listing items that have issues that match one or more of the specified severity levels.
    • OptionalwithStatus: SearchListingsItemsWithStatusEnum[]

      Filter results to include only listing items that have the specified status.
    • OptionalwithoutStatus: SearchListingsItemsWithoutStatusEnum[]

      Filter results to include only listing items that don&#39;t contain the specified statuses.
    • OptionalsortBy: SearchListingsItemsSortByEnum

      An attribute by which to sort the returned listing items.
    • OptionalsortOrder: SearchListingsItemsSortOrderEnum

      The order in which to sort the result items.
    • OptionalpageSize: number

      The number of results that you want to include on each page.
    • OptionalpageToken: string

      A token that you can use to fetch a specific page when there are multiple pages of results.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws