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

    PromotionsApi - object-oriented interface

    Hierarchy (View Summary)

    Index
    axios: AxiosInstance = globalAxios
    basePath: string = BASE_PATH
    configuration: Configuration | undefined
    • Retrieve details of a specified promotion. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.1 | 2 | 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 may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

      Parameters

      Returns Promise<AxiosResponse<GetPromotionResponse, any, {}, any>>

    • 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. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.1 | 2 | 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 may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

      Parameters

      Returns Promise<AxiosResponse<GetSelectionResponse, any, {}, any>>

    • Search and filter promotions based on various criteria. Returns a paginated list of promotion summaries. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.1 | 4 | 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 may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

      Parameters

      Returns Promise<AxiosResponse<SearchPromotionsResponse, any, {}, any>>