Function PromotionsApiFp

Returns {
    getPromotion(
        promotionId: string,
        includedData?: GetPromotionIncludedDataEnum[],
        locale?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetPromotionResponse>,
    >;
    getSelection(
        promotionId: string,
        selectionId: string,
        revisionId: number,
        locale?: string,
        paginationToken?: string,
        limit?: number,
        includedData?: "ISSUES"[],
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetSelectionResponse>,
    >;
    searchPromotions(
        marketplaceIds: string[],
        locale?: string,
        statuses?: SearchPromotionsStatusesEnum[],
        asins?: string[],
        skus?: string[],
        promotionTypes?: SearchPromotionsPromotionTypesEnum[],
        startDateBefore?: string,
        startDateAfter?: string,
        endDateBefore?: string,
        endDateAfter?: string,
        updateDateAfter?: string,
        updateDateBefore?: string,
        paginationToken?: string,
        revision?: SearchPromotionsRevisionEnum,
        limit?: number,
        includedData?: SearchPromotionsIncludedDataEnum[],
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SearchPromotionsResponse>,
    >;
}

• getPromotion: function

  • getPromotion(
        promotionId: string,
        includedData?: GetPromotionIncludedDataEnum[],
        locale?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetPromotionResponse>,
    >

    Retrieve details of a specified promotion.

    Parameters

    • promotionId: string

      The ID of the promotion.

    • OptionalincludedData: GetPromotionIncludedDataEnum[]

      A comma-delimited list of datasets to include in the response.

    • Optionallocale: string

      The locale of the promotion. Formatted as an ISO 639 language code, followed by an underscore, followed by an ISO 3166-1 alpha-2 country code.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getSelection: function

  • getSelection(
        promotionId: string,
        selectionId: string,
        revisionId: number,
        locale?: string,
        paginationToken?: string,
        limit?: number,
        includedData?: "ISSUES"[],
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetSelectionResponse>,
    >

    Retrieve up to 100 product items that are associated with a specified promotion. This operation only supports items found in SelectionType.ITEMS. Items found in SelectionType.CATALOG are not supported. Selection objects always include selectionDetails with item information.

    Parameters

    • promotionId: string

      The ID of the promotion.

    • selectionId: string

      The ID of the selection.

    • revisionId: number

      The revision identifier for the selection. Use the `revisionId` from the `getPromotion` response. A promotion may have multiple selection revisions when an update is in progress. Passing the correct `revisionId` ensures you retrieve the expected data.

    • Optionallocale: string

      The locale of the promotion. Formatted as an ISO 639 language code, followed by an underscore, followed by an ISO 3166-1 alpha-2 country code.

    • OptionalpaginationToken: string

      A token that you use to retrieve the next page of results. The response includes `paginationToken` when the number of results exceeds the specified `limit` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `paginationToken` is null. Note that this operation can return empty pages.

    • Optionallimit: number

      The maximum number of response results per page.

    • OptionalincludedData: "ISSUES"[]

      A comma-delimited list of datasets to include in the response.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• searchPromotions: function

  • searchPromotions(
        marketplaceIds: string[],
        locale?: string,
        statuses?: SearchPromotionsStatusesEnum[],
        asins?: string[],
        skus?: string[],
        promotionTypes?: SearchPromotionsPromotionTypesEnum[],
        startDateBefore?: string,
        startDateAfter?: string,
        endDateBefore?: string,
        endDateAfter?: string,
        updateDateAfter?: string,
        updateDateBefore?: string,
        paginationToken?: string,
        revision?: SearchPromotionsRevisionEnum,
        limit?: number,
        includedData?: SearchPromotionsIncludedDataEnum[],
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SearchPromotionsResponse>,
    >

    Search and filter promotions based on various criteria. Returns a paginated list of promotion summaries.

    Parameters

    • marketplaceIds: string[]

      The Amazon stores from which to retrieve promotions. Refer to Store Identifiers for a list of Amazon store values.

    • Optionallocale: string

      The locale from which to retrieve promotions. Formatted as an ISO 639 language code, followed by an underscore, followed by an ISO 3166-1 alpha-2 country code.

    • Optionalstatuses: SearchPromotionsStatusesEnum[]

      The statuses of promotions to retrieve, formatted as a comma-delimited list.

    • Optionalasins: string[]

      The ASINs to which promotions apply, formatted as a comma-delimited list.

    • Optionalskus: string[]

      The SKUs to which promotions apply, formatted as a comma-delimited list.

    • OptionalpromotionTypes: SearchPromotionsPromotionTypesEnum[]

      The promotion types to which promotions apply, formatted as a comma-delimited list.

    • OptionalstartDateBefore: string

      Promotions that start before this date are returned. Formatted in ISO 8601 format, including the timezone. For example: `1970-01-01T00:00:00-07:00`.

    • OptionalstartDateAfter: string

      Promotions that start after this date are returned. Formatted in ISO 8601 format, including the timezone. For example: `1970-01-01T00:00:00-07:00`.

    • OptionalendDateBefore: string

      Promotions that end before this date are returned. Formatted in ISO 8601 format, including the timezone. For example: `1970-01-01T00:00:00-07:00`.

    • OptionalendDateAfter: string

      Promotions that end after this date are returned. Formatted in ISO 8601 format, including the timezone. For example: `1970-01-01T00:00:00-07:00`.

    • OptionalupdateDateAfter: string

      Filter promotions that were last modified after this timestamp. Zoned Datetime in ISO 8601 format (e.g., 1970-01-01T00:00:00-07:00).

    • OptionalupdateDateBefore: string

      Filter promotions that were last modified before this timestamp. Zoned Datetime in ISO 8601 format (e.g., 1970-01-01T00:00:00-07:00).

    • OptionalpaginationToken: string

      A token that you use to retrieve the next page of results. The response includes `paginationToken` when the number of results exceeds the specified `limit` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `paginationToken` is null. Note that this operation can return empty pages.

    • Optionalrevision: SearchPromotionsRevisionEnum

      Specifies which promotion revision or revisions to match against when filtering. This controls which promotions are included in search results, not the shape of the response. The response always returns the published revision in the main body, with `latestRevision` included when the latest revision diverges.

    • Optionallimit: number

      The maximum number of response results per page.

    • OptionalincludedData: SearchPromotionsIncludedDataEnum[]

      A comma-delimited list of datasets to include in the response.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws