Function ProductTypeDefinitionsApiFp

Returns {
    getDefinitionsProductType(
        productType: string,
        marketplaceIds: string[],
        sellerId?: string,
        productTypeVersion?: string,
        requirements?: GetDefinitionsProductTypeRequirementsEnum,
        requirementsEnforced?: GetDefinitionsProductTypeRequirementsEnforcedEnum,
        locale?: GetDefinitionsProductTypeLocaleEnum,
        parentageLevel?: GetDefinitionsProductTypeParentageLevelEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ProductTypeDefinition>,
    >;
    searchDefinitionsProductTypes(
        marketplaceIds: string[],
        keywords?: string[],
        itemName?: string,
        locale?: string,
        searchLocale?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ProductTypeList>,
    >;
}

• getDefinitionsProductType: function

  • getDefinitionsProductType(
        productType: string,
        marketplaceIds: string[],
        sellerId?: string,
        productTypeVersion?: string,
        requirements?: GetDefinitionsProductTypeRequirementsEnum,
        requirementsEnforced?: GetDefinitionsProductTypeRequirementsEnforcedEnum,
        locale?: GetDefinitionsProductTypeLocaleEnum,
        parentageLevel?: GetDefinitionsProductTypeParentageLevelEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ProductTypeDefinition>,
    >

    Retrieve an Amazon product type definition. Usage Plans: | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 5 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • productType: string

      The Amazon product type name.

    • marketplaceIds: string[]

      A comma-delimited list of Amazon marketplace identifiers for the request. Note: This parameter is limited to one marketplaceId at this time.

    • OptionalsellerId: string

      A selling partner identifier. When provided, seller-specific requirements and values are populated within the product type definition schema, such as brand names associated with the selling partner.

    • OptionalproductTypeVersion: string

      The version of the Amazon product type to retrieve. Defaults to &quot;LATEST&quot;. Prerelease versions of product type definitions may be retrieved with &quot;RELEASE_CANDIDATE&quot;. If no prerelease version is currently available, the &quot;LATEST&quot; live version will be provided.

    • Optionalrequirements: GetDefinitionsProductTypeRequirementsEnum

      The name of the requirements set to retrieve requirements for.

    • OptionalrequirementsEnforced: GetDefinitionsProductTypeRequirementsEnforcedEnum

      Identifies if the required attributes for a requirements set are enforced by the product type definition schema. Non-enforced requirements enable structural validation of individual attributes without all the required attributes being present (such as for partial updates).

    • Optionallocale: GetDefinitionsProductTypeLocaleEnum

      Locale for retrieving display labels and other presentation details. Defaults to the default language of the first marketplace in the request.

    • OptionalparentageLevel: GetDefinitionsProductTypeParentageLevelEnum

      The parentage level of the listing to retrieve a schema for. When provided, the schema is simplified by resolving all conditional logic related to the specified parentage level, resulting in a smaller schema with fewer conditions.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• searchDefinitionsProductTypes: function

  • searchDefinitionsProductTypes(
        marketplaceIds: string[],
        keywords?: string[],
        itemName?: string,
        locale?: string,
        searchLocale?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ProductTypeList>,
    >

    Search for and return a list of Amazon product types that have definitions available. Usage Plans: | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 5 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • marketplaceIds: string[]

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

    • Optionalkeywords: string[]

      A comma-delimited list of keywords to search product types. Note: Cannot be used with `itemName`.

    • OptionalitemName: string

      Title of ASIN to get product type recommendation. Note: Cannot be used with `keywords`.

    • Optionallocale: string

      Locale for display names in response. Defaults to primary locale of the marketplace.

    • OptionalsearchLocale: string

      Language used for `keywords` or `itemName` parameters. Defaults to primary locale of the marketplace.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws