Amazon Selling Partner API (SP-API) SDK for TypeScript
    Preparing search index...

    Interface PromotionsApiSearchPromotionsRequest

    Request parameters for searchPromotions operation in PromotionsApi.

    interface PromotionsApiSearchPromotionsRequest {
        asins?: string[];
        endDateAfter?: string;
        endDateBefore?: string;
        includedData?: SearchPromotionsIncludedDataEnum[];
        limit?: number;
        locale?: string;
        marketplaceIds: string[];
        paginationToken?: string;
        promotionTypes?: SearchPromotionsPromotionTypesEnum[];
        revision?: SearchPromotionsRevisionEnum;
        skus?: string[];
        startDateAfter?: string;
        startDateBefore?: string;
        statuses?: SearchPromotionsStatusesEnum[];
        updateDateAfter?: string;
        updateDateBefore?: string;
    }
    Index
    asins? endDateAfter? endDateBefore? includedData? limit? locale? marketplaceIds paginationToken? promotionTypes? revision? skus? startDateAfter? startDateBefore? statuses? updateDateAfter? updateDateBefore?
    asins?: string[]

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

    endDateAfter?: 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`.

    endDateBefore?: 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`.

    includedData?: SearchPromotionsIncludedDataEnum[]

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

    limit?: number

    The maximum number of response results per page.

    locale?: 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.

    marketplaceIds: string[]

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

    paginationToken?: 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.

    promotionTypes?: SearchPromotionsPromotionTypesEnum[]

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

    revision?: 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.

    skus?: string[]

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

    startDateAfter?: 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`.

    startDateBefore?: 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`.

    statuses?: SearchPromotionsStatusesEnum[]

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

    updateDateAfter?: 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).

    updateDateBefore?: 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).

    Settings
    Member Visibility

    On This Page
    Properties