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

    Module @sp-api-sdk/promotions-api-2025-12-01 - v1.1.0

    @sp-api-sdk/promotions-api-2025-12-01

    npm version XO code style

    The Selling Partner API for Promotions enables selling partners to create and manage promotions.

    Bizon

    Learn more about this Selling Partner API by visiting the official documentation.

    Also, see the generated documentation for this API client.

    npm install @sp-api-sdk/promotions-api-2025-12-01
    
    import {SellingPartnerApiAuth} from '@sp-api-sdk/auth'
    import {PromotionsApiClient} from '@sp-api-sdk/promotions-api-2025-12-01'

    // `clientId` and `clientSecret` default to the `LWA_CLIENT_ID` and
    // `LWA_CLIENT_SECRET` environment variables.
    const auth = new SellingPartnerApiAuth({
    refreshToken: await getRefreshTokenForSeller(sellerId),
    })

    const client = new PromotionsApiClient({
    auth,
    region: 'eu',
    })

    In order to retry rate limited requests (HTTP 429), you can configure the API client as such:

    const client = new PromotionsApiClient({
    auth,
    region: 'eu',
    rateLimiting: {
    retry: true,
    // Optionally specify a callback that will be called on every retry.
    onRetry: (retryInfo) => {
    console.log(retryInfo)
    },
    },
    })

    The rate limits used for each route are specified in the API documentation.

    You can enable logging for both SP-API requests and responses by configuring the logging.request and logging.response properties.

    const client = new PromotionsApiClient({
    auth,
    region: 'eu',
    logging: {
    request: {
    logger: console.debug,
    },
    response: {
    logger: console.debug,
    },
    error: true,
    },
    })

    Specifying true will use the default options, specifying an object will allow you to override the default options.
    This uses axios-logger under the hood.
    By default, if enabled, the request and response loggers will use console.info and the error logger will use console.error.

    MIT

        ╚⊙ ⊙╝
      ╚═(███)═╝
     ╚═(███)═╝
    ╚═(███)═╝
     ╚═(███)═╝
      ╚═(███)═╝
       ╚═(███)═╝
    
    PromotionsApi
    PromotionsApiClient
    AmountThreshold
    BenefitTier
    BrandSegmentDetails
    Budget
    ClaimCode
    Currency
    CustomerSegment
    CustomerSegmentDetails
    Discount
    ErrorList
    GetSelectionResponse
    Issue
    Item
    ItemBenefit
    ItemIdentifier
    ItemIssueAllOf
    LatestRevisionAllOf
    Merchandising
    ModelError
    Pagination
    PreviewedFeeRates
    PromotionBenefit
    PromotionFeeSnapshot
    PromotionRevisionAttributes
    PromotionsApiGetPromotionRequest
    PromotionsApiGetSelectionRequest
    PromotionsApiSearchPromotionsRequest
    PromotionSummaryAllOf
    PurchaseCondition
    PurchaseRequirements
    QuantityThreshold
    Schedule
    SearchPromotionsResponse
    Selection
    SelectionDetails
    SelectionRules
    UpfrontFee
    VariableFee
    AmountThresholdTypeEnum
    BudgetTypeEnum
    ClaimCodeTypeEnum
    CouponType
    CustomerSegmentType
    DiscountTypeEnum
    FeeFrequency
    GetPromotionIncludedDataEnum
    GetPromotionResponse
    GetSelectionIncludedDataEnum
    IssueSeverityEnum
    ItemBenefitTypeEnum
    ItemIssue
    LatestRevision
    LatestRevisionAllOfRevisionStatusEnum
    MerchandisingDisplayOnWebsiteEnum
    PromotionBenefitStackingEnum
    PromotionIssue
    PromotionSummary
    PromotionSummaryAllOfStatusEnum
    PromotionType
    QuantityThresholdTypeEnum
    SearchPromotionsIncludedDataEnum
    SearchPromotionsPromotionTypesEnum
    SearchPromotionsRevisionEnum
    SearchPromotionsStatusesEnum
    SelectionTypeEnum
    AmountThresholdTypeEnum
    BudgetTypeEnum
    ClaimCodeTypeEnum
    clientRateLimits
    CouponType
    CustomerSegmentType
    DiscountTypeEnum
    FeeFrequency
    GetPromotionIncludedDataEnum
    GetSelectionIncludedDataEnum
    IssueSeverityEnum
    ItemBenefitTypeEnum
    LatestRevisionAllOfRevisionStatusEnum
    MerchandisingDisplayOnWebsiteEnum
    PromotionBenefitStackingEnum
    PromotionSummaryAllOfStatusEnum
    PromotionType
    QuantityThresholdTypeEnum
    SearchPromotionsIncludedDataEnum
    SearchPromotionsPromotionTypesEnum
    SearchPromotionsRevisionEnum
    SearchPromotionsStatusesEnum
    SelectionTypeEnum
    PromotionsApiAxiosParamCreator
    PromotionsApiFactory
    PromotionsApiFp